Retrieve a Pix key

cURL with fictitious data

curl --request GET \
  --url https://api.example.com/dict-hub/v1/keys/pix-demo@example.com \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc' \
  --header 'X-End-To-End-Id: E12345678202401011200abcdef12345'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/dict-hub/v1/keys/{key}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.example.com/dict-hub/v1/keys/{key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/dict-hub/v1/keys/{key}"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "account": {
    "branch": "0001",
    "number": "0007654321",
    "openingDate": "2010-01-10T03:00:00Z",
    "participant": "12345678",
    "type": "CACC"
  },
  "createdAt": "2019-11-18T03:00:00Z",
  "endToEndId": "E12345678202401011200abcdef12345",
  "keyOwnershipDate": "2019-11-18T03:00:00Z",
  "keyType": "CPF",
  "keyValue": "52998224725",
  "person": {
    "document": "52998224725",
    "name": "João Silva",
    "personType": "NATURAL",
    "tradeName": "Silva ME"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

keys

{key}

cURL with fictitious data

curl --request GET \
  --url https://api.example.com/dict-hub/v1/keys/pix-demo@example.com \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc' \
  --header 'X-End-To-End-Id: E12345678202401011200abcdef12345'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/dict-hub/v1/keys/{key}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.example.com/dict-hub/v1/keys/{key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/dict-hub/v1/keys/{key}"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "account": {
    "branch": "0001",
    "number": "0007654321",
    "openingDate": "2010-01-10T03:00:00Z",
    "participant": "12345678",
    "type": "CACC"
  },
  "createdAt": "2019-11-18T03:00:00Z",
  "endToEndId": "E12345678202401011200abcdef12345",
  "keyOwnershipDate": "2019-11-18T03:00:00Z",
  "keyType": "CPF",
  "keyValue": "52998224725",
  "person": {
    "document": "52998224725",
    "name": "João Silva",
    "personType": "NATURAL",
    "tradeName": "Silva ME"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id

string

required

UUID of the account associated with the operation.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

X-End-To-End-Id

string

End-to-end correlation ID (exactly 32 characters)

Example:

"E12345678202401011200abcdef12345"

Path Parameters

key

string

required

Pix key value (CPF, CNPJ, email, +E.164 phone, or EVP UUID)

Example:

"52998224725"

Response

account

object

required

Show child attributes

createdAt

string<date-time>

required

Example:

"2019-11-18T03:00:00Z"

keyType

string

required

Example:

"CPF"

keyValue

string

required

Example:

"52998224725"

person

object

required

Show child attributes

endToEndId

string

Example:

"E12345678202401011200abcdef12345"

keyOwnershipDate

string<date-time>

Example:

"2019-11-18T03:00:00Z"

DICT and Pix keys

Collections and BR Codes

Payments and refunds

Error handling

Retrieve a Pix key

Authorizations

Headers

Path Parameters

Response