Obtenha o status KYC
curl --request GET \
--url https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status', 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://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status",
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://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status"
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://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status")
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{
"entityId": "5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"status": "IN_REVIEW",
"documentationStatus": "COMPLETE",
"statusReason": "Review started",
"documents": [
{
"documentId": "2e16d844-4fa9-4295-9a21-83ec32ef241a",
"type": "CPF",
"status": "VERIFIED",
"proofs": [
{
"proofId": "2c4c2f74-7179-4113-83fb-f11dbce9e07d",
"verificationStatus": "APPROVED"
}
]
},
{
"documentId": "e0ea9515-442e-4bc5-bc82-b8d278255c37",
"type": "PROOF_OF_ADDRESS",
"status": "VERIFIED",
"proofs": [
{
"proofId": "acb78b3f-fe18-4094-b6a9-2107f502d709",
"verificationStatus": "APPROVED"
}
]
}
]
}
Entidades
Obtenha o status KYC
GET
/
api
/
entity
/
v1
/
entities
/
{entityId}
/
kyc-status
Obtenha o status KYC
curl --request GET \
--url https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status', 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://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status",
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://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status"
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://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}/kyc-status")
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{
"entityId": "5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"status": "IN_REVIEW",
"documentationStatus": "COMPLETE",
"statusReason": "Review started",
"documents": [
{
"documentId": "2e16d844-4fa9-4295-9a21-83ec32ef241a",
"type": "CPF",
"status": "VERIFIED",
"proofs": [
{
"proofId": "2c4c2f74-7179-4113-83fb-f11dbce9e07d",
"verificationStatus": "APPROVED"
}
]
},
{
"documentId": "e0ea9515-442e-4bc5-bc82-b8d278255c37",
"type": "PROOF_OF_ADDRESS",
"status": "VERIFIED",
"proofs": [
{
"proofId": "acb78b3f-fe18-4094-b6a9-2107f502d709",
"verificationStatus": "APPROVED"
}
]
}
]
}
Retorna uma árvore compacta do estado da revisão: status da entidade, cobertura da documentação, o status de cada documento e prova ativa, e o motivo da última mudança de status. Use-a para acompanhar a revisão realizada pela Localpayment.
- O exemplo principal foi capturado com o caso em IN_REVIEW e com os dois arquivos já aprovados; o segundo, logo após o upload, com os arquivos ainda em PENDING.
- documentationStatus: COMPLETE significa que todos os documentos têm um arquivo; não significa que os arquivos foram aprovados. A aprovação se reflete em documents[].status = VERIFIED e proofs[].verificationStatus = APPROVED.
application/problem+json com um code estável. Catálogo completo: Status de Entidades e Códigos de Erro.Autorizações
Cabeçalhos
Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso. Sua conta de comerciante e o usuário que realiza a ação são identificados a partir dele.
Exemplo:
"Bearer <your_access_token>"
Parâmetros de caminho
Resposta
OK.
Última modificação em 10 de novembro de 2026

