Get a Pix key entry

Retrieves a Pix entry by its unique identifier, scoped to the calling account.

GET /entries/{entry_id}

cURL with fictitious data

cURL

curl --request GET \
  --url https://api.example.com/dict-hub/v1/entries/019606d4-6e7f-8091-2c34-567890123def \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'

200

{
  "account": {
    "branch": "0001",
    "number": "0007654321",
    "openingDate": "2010-01-10T03:00:00Z",
    "participant": "12345678",
    "type": "CACC"
  },
  "createdAt": "2019-11-18T03:00:00Z",
  "holderId": "019606e5-7f80-9102-3d45-678901234ef0",
  "id": "019606c3-5d6e-7f80-1b23-456789012cde",
  "keyCreationDate": "2019-11-18T03:00:00Z",
  "keyOwnershipDate": "2019-11-18T03:00:00Z",
  "keyType": "CPF",
  "keyValue": "52998224725",
  "metadata": {
    "field": "field-example"
  },
  "organizationId": "019606d4-6e7f-8091-2c34-567890123def",
  "owner": {
    "document": "52998224725",
    "name": "João Silva",
    "personType": "NATURAL",
    "tradeName": "Silva ME"
  },
  "requestId": "a946d533-7f22-42a5-9a9b-e87cd55c0f4d",
  "status": "ACTIVE",
  "updatedAt": "2019-11-18T03:00:00Z"
}

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"

Path Parameters

entry_id · string · required

Entry ID (UUID format)

Example:

"019606c3-5d6e-7f80-1b23-456789012cde"

Response

200

application/json

OK

account · object · required

Show child attributes

createdAt · string<date-time> · required

Example:

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

holderId · string · required

Example:

"019606e5-7f80-9102-3d45-678901234ef0"

id · string · required

Example:

"019606c3-5d6e-7f80-1b23-456789012cde"

keyCreationDate · string<date-time> · required

Example:

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

keyOwnershipDate · string<date-time> · required

Example:

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

keyType · string · required

Example:

"CPF"

keyValue · string · required

Example:

"52998224725"

organizationId · string · required

Example:

"019606d4-6e7f-8091-2c34-567890123def"

owner · object · required

Show child attributes

requestId · string · required

Example:

"a946d533-7f22-42a5-9a9b-e87cd55c0f4d"

status · string · required

Example:

"ACTIVE"

updatedAt · string<date-time> · required

Example:

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

metadata · object

Show child attributes