Retrieve a Pix key

Queries the DICT system for Pix key details for payment preparation. The key type is inferred server-side from the value’s shape.

GET /keys/{key}

Retrieve a Pix key

cURL

curl --request GET \
  --url https://api.example.com/dict-hub/v1/keys/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

200

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

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id · string · requerido

Account ID (UUID format)

Ejemplo:

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

X-End-To-End-Id · string

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

Ejemplo:

"E12345678202401011200abcdef12345"

Parámetros de ruta

key · string · requerido

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

Ejemplo:

"52998224725"

Respuesta

200

application/json

OK

account · object · requerido

Show child attributes

createdAt · string<date-time> · requerido

Ejemplo:

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

keyType · string · requerido

Ejemplo:

"CPF"

keyValue · string · requerido

Ejemplo:

"52998224725"

person · object · requerido

Show child attributes

endToEndId · string

Ejemplo:

"E12345678202401011200abcdef12345"

keyOwnershipDate · string<date-time>

Ejemplo:

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