Querying key claims

Request

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

curl --request POST \
     --url https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims/search \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --data '
{
    "participationFlowType": "CLAIMANT",
    "status": "PENDING",
    "account": {
        "number": "2000",
        "branch": "0001",
        "type": "CURRENT"
    }
}
'

Header

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
participationFlowType	`string`	Required. Type of participation in the claiming process. Domains: `DONOR` - Key donor `CLAIMANT` - Key claimant
status	`object`	Claiming status (DEFAULT: `AWAITING_RESOLUTION`). Domains: `PENDIG` - Em aberto/Pendente `AWAITING_RESOLUTION` `CONFIRMED` `CANCELED` `COMPLETED`
account	`object`	Object containing information about the end client account.
account.number	`string`	End client’s bank account number
account.branch	`string`	End client’s bank account branch
account.type	`enum`	End client’s bank account type. Domain: `CURRENT` - Current Account `PAYMENT` - Payment Account `SAVING` - Savings Account `SALARY` - Salary Account
account.holder	`object`	Object containing information about the bank account holder.
account.holder.document	`string`	Required if holder is not empty. Bank account holder’s name
account.holder.type	`enum`	Required if holder is not empty. Bank account holder’s document type. Domains: `NATURAL` - Natural Person `LEGAL` - Legal Person

Response

The status code 200 will indicate success in the transaction.

Being well-succeeded, the return will have the following fields:

[
    {
        "id": "6ab2d260-16db-4d7f-aac9-a91ba038f82d",
        "type": "PORTABILITY",
        "status": "PENDING",
        "participationFlowType": "CLAIMANT",
        "entry": {
            "key": "06130856555",
            "type": "DOCUMENT"
        },
        "updatedAt": "2023-10-23T13:37:30.161Z",
        "resolutionDeadline": "2023-10-30T13:37:30.161Z",
        "donorParticipant": {
            "name": "EBANX IP LTDA.",
            "ispb": "21018182"
        },
        "claimantAccount": {
            "number": "2000",
            "branch": "0001",
            "type": "CURRENT",
            "participant": {
                "name": "AGILE CORPORATION",
                "ispb": "12573115"
            },
            "holder": {
                "name": "NATURAL PERSON LOREN IPSUN LOREN",
                "document": "06130856555",
                "type": "NATURAL"
            }
        }
    }
]

Body

Name	Type	Description
id	`string`	Claiming Id
type	`enum`	Claiming type. Domains: `PORTABILITY` - Used when the claiming is for an EMAIL or PHONE key type `OWNERSHIP` - Used when the claiming is for an EMAIL or PHONE key type
status	`enum`	Claiming status. Domains: `PENDIG` `AWAITING_RESOLUTION` `CONFIRMED` `CANCELED` `COMPLETED`
resolutionDeadline	`datetime`	Resolution date limit. UTC Format: `yyyy-MM-ddTHH:mm:ss.fffZ`
donorParticipant	`object`	Information about the key donor (current key owner)
donorParticipant.name	`string`	Participant name that contains the donor key (current key owner)
donorParticipant.ispb	`string`	IParticipant’s ISPB that containing the doner key (current key owner)