Saltar al contenido principal
GET
/
api
/
v1
/
dict
/
claims
/
{claimID}
Obtener reclamo
curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "claimType": "<string>",
  "claimerISPB": "<string>",
  "deadline": "<string>",
  "donorISPB": "<string>",
  "id": "<string>",
  "keyType": "<string>",
  "keyValue": "<string>",
  "requestedAt": "<string>",
  "status": "<string>",
  "resolution": "<string>",
  "resolvedAt": "<string>"
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

claimID
string
requerido

Claim UUID

Respuesta

OK

Claim record with its current status and deadlines

claimType
string
requerido

Claim kind: OWNERSHIP or PORTABILITY

Ejemplo:

"OWNERSHIP"

claimerISPB
string
requerido

ISPB (8 numeric digits) of the participant initiating the claim

Ejemplo:

"12345678"

deadline
string
requerido

Donor-response deadline, seven days after initiation (RFC 3339, UTC)

Ejemplo:

"2025-03-14T14:30:00Z"

donorISPB
string
requerido

ISPB (8 numeric digits) of the current key owner (donor), resolved during initiation

Ejemplo:

"87654321"

id
string
requerido

Server-assigned claim UUID

Ejemplo:

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

keyType
string
requerido

PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP

Ejemplo:

"CPF"

keyValue
string
requerido

PIX key value under claim

Ejemplo:

"12345678901"

requestedAt
string
requerido

Claim initiation timestamp (RFC 3339, UTC)

Ejemplo:

"2025-03-07T14:30:00Z"

status
string
requerido

Claim lifecycle state: OPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, or COMPLETED

Ejemplo:

"OPEN"

resolution
string

Terminal resolution reason (e.g. DONOR_CONFIRMED, CANCELLED_BY_CLAIMER, CANCELLED_BY_CLAIMER_FRAUD, CANCELLED_BY_DONOR, CANCELLED_BY_DONOR_FRAUD, DEADLINE_EXPIRED); empty until the claim resolves

Ejemplo:

""

resolvedAt
string

Resolution timestamp (RFC 3339, UTC); omitted while the claim is unresolved

Ejemplo:

""