Create a Key Claim

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/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://plugin-pix-indirect.api.lerian.net/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://plugin-pix-indirect.api.lerian.net/v1/dict/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/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"
}

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

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

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

POST

dict

claims

Create a Key Claim

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/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://plugin-pix-indirect.api.lerian.net/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://plugin-pix-indirect.api.lerian.net/v1/dict/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/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"
}

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

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

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id

string<uuid>

required

Account ID (UUID format)

X-Reason

enum<string>

required

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

Available options:

USER_REQUESTED,

ACCOUNT_CLOSURE,

DEFAULT_OPERATION,

FRAUD,

RECONCILIATION

Body

application/json

key

string

required

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

Minimum string length: 1

Example:

"+5561988887777"

type

enum<string>

required

Type of claim (OWNERSHIP or PORTABILITY)

Available options:

OWNERSHIP,

PORTABILITY

Minimum string length: 1

Example:

"OWNERSHIP"

Response

Created

accountId

string

required

Unique identifier of the account

Example:

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

bacenClaimId

string

required

BACEN DICT identifier for this claim

Example:

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

cancelReason

enum<string>

required

Reason provided when the claim was cancelled

Available options:

USER_REQUESTED,

ACCOUNT_CLOSURE,

DEFAULT_OPERATION,

FRAUD,

RECONCILIATION

Example:

"FRAUD"

cancelledBy

enum<string>

required

Who cancelled the claim (donor PSP or claimer PSP)

Available options:

DONOR,

CLAIMER

Example:

"DONOR"

claimer

object

required

Account owner information

Show child attributes

claimerAccount

object

required

Account information of the claimer

Show child attributes

completedAt

string<date-time>

required

Timestamp when the claim was completed

Example:

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

completionPeriodEnd

string<date-time>

required

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

Example:

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

confirmReason

enum<string>

required

Reason provided when the claim was confirmed

Available options:

USER_REQUESTED,

ACCOUNT_CLOSURE,

DEFAULT_OPERATION,

FRAUD,

RECONCILIATION

Example:

"DEFAULT_OPERATION"

createdAt

string<date-time>

required

Timestamp when the claim was created

Example:

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

donorParticipant

string

required

ISPB of the donor PSP that currently holds the key

Example:

"30306294"

holderId

string

required

Unique identifier of the account holder

Example:

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

string

required

Unique identifier of the claim

Example:

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

key

string

required

Pix key value being claimed

Example:

"+5561988887777"

keyType

enum<string>

required

Type of Pix key being claimed

Available options:

PHONE,

EMAIL,

CPF,

CNPJ,

EVP

Example:

"PHONE"

resolutionPeriodEnd

string<date-time>

required

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

Example:

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

status

enum<string>

required

Current status of the claim

Available options:

OPEN,

WAITING_RESOLUTION,

CONFIRMED,

CANCELLED,

COMPLETED

Example:

"OPEN"

type

enum<string>

required

Type of claim being processed

Available options:

OWNERSHIP,

PORTABILITY

Example:

"OWNERSHIP"

updatedAt

string<date-time>

required

Timestamp when the claim was last updated

Example:

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

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Transaction times

Webhooks API

Error handling

Create a Key Claim

Authorizations

Headers

Body

Response