Create a Key Claim

curl --request POST \
  --url https://api.example.com/v1/dict/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Reason: <x-reason>' \
  --data '
{
  "key": "+5561988887777",
  "type": "OWNERSHIP"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/dict/claims"

	payload := strings.NewReader("{\n  \"key\": \"+5561988887777\",\n  \"type\": \"OWNERSHIP\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("X-Reason", "<x-reason>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    'X-Reason': '<x-reason>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({key: '+5561988887777', type: 'OWNERSHIP'})
};

fetch('https://api.example.com/v1/dict/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/dict/claims"

payload = {
    "key": "+5561988887777",
    "type": "OWNERSHIP"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "X-Reason": "<x-reason>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "accountId": "550e8400-e29b-41d4-a716-446655440002",
  "bacenClaimId": "cc91b1b0-8465-44b1-a760-15dd3717ea9b",
  "cancelReason": "FRAUD",
  "cancelledBy": "DONOR",
  "claimer": {
    "document": "52998224725",
    "name": "Antonio Jose Raimundo",
    "type": "NATURAL_PERSON"
  },
  "claimerAccount": {
    "branch": "0001",
    "number": "2227654330",
    "openingDate": "2020-08-17T13:48:36Z",
    "participant": "30306294",
    "type": "TRAN"
  },
  "completedAt": "2020-08-31T13:48:55Z",
  "completionPeriodEnd": "2020-09-07T13:48:55Z",
  "confirmReason": "DEFAULT_OPERATION",
  "createdAt": "2020-08-17T13:48:36Z",
  "donorParticipant": "30306294",
  "holderId": "550e8400-e29b-41d4-a716-446655440001",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "+5561988887777",
  "keyType": "PHONE",
  "resolutionPeriodEnd": "2020-08-24T13:48:55Z",
  "status": "OPEN",
  "type": "OWNERSHIP",
  "updatedAt": "2020-08-17T14:00:00Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

POST

dict

claims

Create a Key Claim

curl --request POST \
  --url https://api.example.com/v1/dict/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Reason: <x-reason>' \
  --data '
{
  "key": "+5561988887777",
  "type": "OWNERSHIP"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/dict/claims"

	payload := strings.NewReader("{\n  \"key\": \"+5561988887777\",\n  \"type\": \"OWNERSHIP\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("X-Reason", "<x-reason>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    'X-Reason': '<x-reason>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({key: '+5561988887777', type: 'OWNERSHIP'})
};

fetch('https://api.example.com/v1/dict/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/dict/claims"

payload = {
    "key": "+5561988887777",
    "type": "OWNERSHIP"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "X-Reason": "<x-reason>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "accountId": "550e8400-e29b-41d4-a716-446655440002",
  "bacenClaimId": "cc91b1b0-8465-44b1-a760-15dd3717ea9b",
  "cancelReason": "FRAUD",
  "cancelledBy": "DONOR",
  "claimer": {
    "document": "52998224725",
    "name": "Antonio Jose Raimundo",
    "type": "NATURAL_PERSON"
  },
  "claimerAccount": {
    "branch": "0001",
    "number": "2227654330",
    "openingDate": "2020-08-17T13:48:36Z",
    "participant": "30306294",
    "type": "TRAN"
  },
  "completedAt": "2020-08-31T13:48:55Z",
  "completionPeriodEnd": "2020-09-07T13:48:55Z",
  "confirmReason": "DEFAULT_OPERATION",
  "createdAt": "2020-08-17T13:48:36Z",
  "donorParticipant": "30306294",
  "holderId": "550e8400-e29b-41d4-a716-446655440001",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "+5561988887777",
  "keyType": "PHONE",
  "resolutionPeriodEnd": "2020-08-24T13:48:55Z",
  "status": "OPEN",
  "type": "OWNERSHIP",
  "updatedAt": "2020-08-17T14:00:00Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string<uuid>

requerido

Account ID (UUID format)

X-Reason

enum<string>

requerido

Reason for claim: USER_REQUESTED, ACCOUNT_CLOSURE, DEFAULT_OPERATION, FRAUD, RECONCILIATION

Opciones disponibles:

USER_REQUESTED,

ACCOUNT_CLOSURE,

DEFAULT_OPERATION,

FRAUD,

RECONCILIATION

Cuerpo

application/json

key

string

requerido

Pix key value to claim (phone, email, CPF, CNPJ, or EVP)

Minimum string length: 1

Ejemplo:

"+5561988887777"

type

enum<string>

requerido

Type of claim (OWNERSHIP or PORTABILITY)

Opciones disponibles:

OWNERSHIP,

PORTABILITY

Minimum string length: 1

Ejemplo:

"OWNERSHIP"

Respuesta

Created

accountId

string

requerido

Unique identifier of the account

Ejemplo:

"550e8400-e29b-41d4-a716-446655440002"

bacenClaimId

string

requerido

BACEN DICT identifier for this claim

Ejemplo:

"cc91b1b0-8465-44b1-a760-15dd3717ea9b"

cancelReason

enum<string>

requerido

Reason provided when the claim was cancelled

Opciones disponibles:

USER_REQUESTED,

ACCOUNT_CLOSURE,

DEFAULT_OPERATION,

FRAUD,

RECONCILIATION,

COURT_ORDER,

PARTICIPANT_EXCLUSION

Ejemplo:

"FRAUD"

cancelledBy

enum<string>

requerido

Who cancelled the claim (donor PSP or claimer PSP)

Opciones disponibles:

DONOR,

CLAIMER

Ejemplo:

"DONOR"

claimer

object

requerido

Account owner information

Show child attributes

claimerAccount

object

requerido

Account information of the claimer

Show child attributes

completedAt

string<date-time>

requerido

Timestamp when the claim was completed

Ejemplo:

"2020-08-31T13:48:55Z"

completionPeriodEnd

string<date-time>

requerido

Deadline for completing the claim process (D+14 from creation)

Ejemplo:

"2020-09-07T13:48:55Z"

confirmReason

enum<string>

requerido

Reason provided when the claim was confirmed

Opciones disponibles:

USER_REQUESTED,

ACCOUNT_CLOSURE,

DEFAULT_OPERATION,

FRAUD,

RECONCILIATION

Ejemplo:

"DEFAULT_OPERATION"

createdAt

string<date-time>

requerido

Timestamp when the claim was created

Ejemplo:

"2020-08-17T13:48:36Z"

donorParticipant

string

requerido

ISPB of the donor PSP that currently holds the key

Ejemplo:

"30306294"

holderId

string

requerido

Unique identifier of the account holder

Ejemplo:

"550e8400-e29b-41d4-a716-446655440001"

string

requerido

Unique identifier of the claim

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

key

string

requerido

Pix key value being claimed

Ejemplo:

"+5561988887777"

keyType

enum<string>

requerido

Type of Pix key being claimed

Opciones disponibles:

PHONE,

EMAIL,

CPF,

CNPJ,

EVP

Ejemplo:

"PHONE"

resolutionPeriodEnd

string<date-time>

requerido

Deadline for donor PSP to respond (D+7 from creation)

Ejemplo:

"2020-08-24T13:48:55Z"

status

enum<string>

requerido

Current status of the claim

Opciones disponibles:

OPEN,

WAITING_RESOLUTION,

CONFIRMED,

CANCELLED,

COMPLETED

Ejemplo:

"OPEN"

type

enum<string>

requerido

Type of claim being processed

Opciones disponibles:

OWNERSHIP,

PORTABILITY

Ejemplo:

"OWNERSHIP"

updatedAt

string<date-time>

requerido

Timestamp when the claim was last updated

Ejemplo:

"2020-08-17T14:00:00Z"

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

Create a Key Claim

Autorizaciones

Encabezados

Cuerpo

Respuesta