Querying a client key

🚧
Important
To avoid transferring customer data via the URL, the method available is of the POST type and therefore, the parameters must be passed in the Body

Request

POST 'https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/entries/search'

curl --request POST \
     --url https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --data '
{
    "type": "DOCUMENT",
    "account": {
        "type": "CURRENT",
        "number": "2000",
        "branch": "0001",
        "createdAt": "2023-05-07T16:36:08.111Z",
        "holder": {
            "document": "06130856555",
            "name": "NATURAL PERSON LOREN IPSUN LOREN",
            "type": "NATURAL"
        }
    }
}
'

curl --request POST \
     --url https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --data '
{
    "key": "+5579999999999",
    "type": "PHONE",
    "account": {
        "type": "CURRENT",
        "number": "2000",
        "branch": "0001",
        "createdAt": "2023-05-07T16:36:08.111Z",
        "holder": {
            "document": "06130856555",
            "name": "NATURAL PERSON LOREN IPSUN LOREN",
            "type": "NATURAL"
        }
    }
}
'

Headers

Name	Description
x-delbank-api-key	Required. API key
IdempotencyKey	Required. Request's idempotency key. Provide a GUID, being a new one for each request.

Body

Name	Type	Description
number	`string`	Client’s bank account number - Required - Min length: 1 - Max length: 20
branch	`string`	Client’s bank account branch - Required - Length: 4
type	`enum`	Required. Client’s bank account type. Domain: `CURRENT` - Current account `PAYMENT` - Payment account `SAVING` - Saving account `SALARY` - Salary account
holder	`object`	Required. Object containing the holder bank account information.
holder.document	`string`	Required. Holder’s document.
holder.type	`enum`	Required. Type of the holder’s document. Domains: `NATURAL` - Natural person `LEGAL` - Legal person

{
    "number": "10001",
    "branch": "0001",
    "type": "PAYMENT",
    "holder": {
        "document": "60680955097",
        "type": "NATURAL"
    }
}

Response

The status code 200 will indicate success in the transaction.

If successful, the return will bring a list with the following fields in JSON format:

[
    {
        "key": "+5555991000031",
        "type": "PHONE",
        "createdAt": "2023-11-07T10:53:52.899Z",
        "updatedAt": "2023-11-07T10:53:52.887Z",
        "account": {
            "number": "10001",
            "branch": "0001",
            "type": "PAYMENT",
            "createdAt": "2023-07-20T20:00:00.000Z",
            "participant": {
                "name": "PARTICIPANT NAME",
                "ispb": "99999999"
            },
            "holder": {
                "name": "TESTE DICT OK",
                "document": "60680955097",
                "type": "NATURAL"
            }
        }
    },
    {
        "key": "36b9487e-b606-4287-abce-4e16c820f697",
        "type": "EVP",
        "createdAt": "2023-10-20T10:03:06.923Z",
        "updatedAt": "2023-10-20T10:03:06.923Z",
        "account": {
            "number": "10001",
            "branch": "0001",
            "type": "PAYMENT",
            "createdAt": "2023-07-20T20:00:00.000Z",
            "participant": {
                "name": "PARTICIPANT NAME",
                "ispb": "99999999"
            },
            "holder": {
                "name": "TESTE DICT OK",
                "document": "60680955097",
                "type": "NATURAL"
            }
        }
    }
]

Body

Name	Type	Description
type	`string`	Key type
key	`string`	Key value
account	`object`	Account information for the customer creating the key
account.number	`string`	Customer account number
account.branch	`string`	Client Account Agency
account.type	`enum`	Customer account type
account.createdAt	`datetime`	Account opening date Format: `yyyy-MM-dd'T'HH:mm:ss.fffZ`
participant	`object`	Information of the participant holding the key
participant.name	`string`	Participant's name
participant.ispb	`string`	Participant's ISPB
account.holder	`object`	Account holder information
account.holder.document	`string`	Holder's name
account.holder.name	`string`	Holder's document (CPF or CNPJ)
account.holder.type	`enum`	Holder's document type. Domains: `NATURAL` - Natural Person `LEGAL` - Legal Person

🚧Important

Request

Headers

Body

Response

Body

🚧
Important