Skip to main content
POST
/
api
/
v1
/
dict
/
claims
/
{claimID}
/
complete
Complete claim
curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
import requests

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

payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/claims/{claimID}/complete', 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}/complete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([

]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

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

payload := strings.NewReader("{}")

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

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))

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

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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"
}

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key
string

Idempotency key, max 255 characters

Path Parameters

claimID
string
required

Claim UUID

Body

application/json

Optional empty body; the decision is determined by the operation path (confirm/reject/acknowledge/complete)

Response

OK

Claim record with its current status and deadlines

claimType
string
required

Claim kind: OWNERSHIP or PORTABILITY

Example:

"OWNERSHIP"

claimerISPB
string
required

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

Example:

"12345678"

deadline
string
required

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

Example:

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

donorISPB
string
required

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

Example:

"87654321"

id
string
required

Server-assigned claim UUID

Example:

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

keyType
string
required

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

Example:

"CPF"

keyValue
string
required

PIX key value under claim

Example:

"12345678901"

requestedAt
string
required

Claim initiation timestamp (RFC 3339, UTC)

Example:

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

status
string
required

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

Example:

"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

Example:

""

resolvedAt
string

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

Example:

""