Obtener una entidad
curl --request GET \
--url https://api.stage.localpayment.com/api/entity/v1/entities/{entityId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}")
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{
"internalId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"externalId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "COMPANY",
"status": "PENDING_KYC",
"name": "Example Company S.A.",
"lastname": null,
"birthdate": null,
"gender": null,
"nationality": null,
"birthCountry": null,
"residenceCountry": null,
"occupation": null,
"isPep": false,
"incorporationDate": "2020-01-15",
"incorporationCountry": "BRA",
"website": "https://www.example.com/new",
"legalRepresentativeName": "Jane Doe",
"email": "test@example.com",
"phone": {
"countryCode": "55",
"areaCode": "11",
"number": "999990099"
},
"address": {
"street": "Rua Exemplo",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100",
"number": "200",
"comment": "Sala 1",
"country": "BRA",
"line2": "Sala 100",
"line3": "Torre A"
},
"attributes": {
"emailPixKey": "test@example.com",
"socialMedia": "https://www.linkedin.com/company/example",
"numberOfEmployees": "11-50",
"countryTaxResidence": "BRA",
"sourceOfFundsAndIncome": "sales_of_goods_and_services",
"reasonForAccountOpening": "receive_payments_for_goods_and_services",
"estimatedAnnualRevenueUsd": "1m_to_10m",
"estimatedMonthlyVolumeUsd": "50000",
"businessActivityDescription": "Online retail of home goods. Receives payments from end customers in Brazil via PIX."
},
"documentationStatus": "COMPLETE",
"document": {
"documentId": "91eaf0c8-844b-42a1-a614-304edbcfa57d",
"entityId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "CNPJ",
"id": "00000000000100",
"issuingCountry": "BRA",
"issueDate": null,
"expirationDate": null,
"isPrimary": true,
"status": "VERIFIED",
"metadata": null,
"proofs": [
{
"id": "ab62c0eb-e921-4d78-9887-25aa57c56c94",
"documentId": "91eaf0c8-844b-42a1-a614-304edbcfa57d",
"proofType": "DOCUMENT",
"fileName": "proof_of_address_company.pdf",
"mimeType": "application/pdf",
"sizeBytes": 53248,
"verificationStatus": "APPROVED",
"verifiedBy": "67890",
"verifiedAt": "2024-01-15T17:20:45Z",
"verificationReason": null,
"uploadedBy": "12345",
"uploadedAt": "2024-01-15T17:19:54Z",
"status": "CURRENT",
"supersededAt": null,
"supersededBy": null,
"replacedByProofId": null,
"deletedAt": null,
"deletedBy": null,
"inVerification": false
}
],
"createdAt": "2024-01-15T17:18:53Z",
"updatedAt": "2024-01-15T17:19:26Z"
},
"documents": [
{
"documentId": "a4f9d2ed-c365-4a0b-b775-9278c039af93",
"entityId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "ARTICLES_OF_INCORPORATION",
"id": "ART-00000000000100",
"issuingCountry": "BRA",
"issueDate": null,
"expirationDate": null,
"isPrimary": false,
"status": "VERIFIED",
"metadata": null,
"proofs": [
{
"id": "0b2e18fb-1b61-402c-be80-863735d3fa4d",
"documentId": "a4f9d2ed-c365-4a0b-b775-9278c039af93",
"proofType": "DOCUMENT",
"fileName": "certificate_of_incorporation.pdf",
"mimeType": "application/pdf",
"sizeBytes": 55296,
"verificationStatus": "APPROVED",
"verifiedBy": "67890",
"verifiedAt": "2024-01-15T17:20:43Z",
"verificationReason": null,
"uploadedBy": "12345",
"uploadedAt": "2024-01-15T17:19:52Z",
"status": "CURRENT",
"supersededAt": null,
"supersededBy": null,
"replacedByProofId": null,
"deletedAt": null,
"deletedBy": null,
"inVerification": false
}
],
"createdAt": "2024-01-15T17:18:53Z",
"updatedAt": "2024-01-15T17:19:26Z"
},
{
"documentId": "5ca3e868-2b76-4390-b25a-5d10c0db8516",
"entityId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "TAX_ID",
"id": "00.000.000/0001-00",
"issuingCountry": "BRA",
"issueDate": "2024-01-15",
"expirationDate": "2034-01-15",
"isPrimary": false,
"status": "VERIFIED",
"metadata": {
"tin": "formatted"
},
"proofs": [
{
"id": "13db8888-d5e6-4c47-95ce-1b962a63645c",
"documentId": "5ca3e868-2b76-4390-b25a-5d10c0db8516",
"proofType": "DOCUMENT",
"fileName": "company_tax_identification_document.pdf",
"mimeType": "application/pdf",
"sizeBytes": 53248,
"verificationStatus": "APPROVED",
"verifiedBy": "67890",
"verifiedAt": "2024-01-15T17:20:44Z",
"verificationReason": null,
"uploadedBy": "12345",
"uploadedAt": "2024-01-15T17:19:53Z",
"status": "CURRENT",
"supersededAt": null,
"supersededBy": null,
"replacedByProofId": null,
"deletedAt": null,
"deletedBy": null,
"inVerification": false
}
],
"createdAt": "2024-01-15T17:18:54Z",
"updatedAt": "2024-01-15T17:19:32Z"
}
],
"version": 3,
"createdAt": "2024-01-15T17:18:53Z",
"updatedAt": "2024-01-15T17:19:26Z",
"customFieldSchemaVersion": 9,
"uboCount": 2,
"uboRequirementMet": true
}{
"type": "about:blank",
"title": "Validation error",
"status": 400,
"detail": "A field, header, path or query parameter is missing, unknown or invalid. details[] lists field and issue.",
"instance": "/api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"code": "VALIDATION_ERROR",
"correlationId": "0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10",
"details": [
{
"field": "externalId",
"issue": "REQUIRED"
}
]
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid access token.",
"instance": "/api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"code": "UNAUTHORIZED",
"correlationId": "0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10",
"details": []
}{
"type": "about:blank",
"title": "Not found",
"status": 404,
"detail": "The entity does not exist or belongs to another merchant.",
"instance": "/api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"code": "ENTITY_NOT_FOUND",
"correlationId": "0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10",
"details": []
}Entidades
Obtener una entidad
GET
/
api
/
entity
/
v1
/
entities
/
{entityId}
Obtener una entidad
curl --request GET \
--url https://api.stage.localpayment.com/api/entity/v1/entities/{entityId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}")
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{
"internalId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"externalId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "COMPANY",
"status": "PENDING_KYC",
"name": "Example Company S.A.",
"lastname": null,
"birthdate": null,
"gender": null,
"nationality": null,
"birthCountry": null,
"residenceCountry": null,
"occupation": null,
"isPep": false,
"incorporationDate": "2020-01-15",
"incorporationCountry": "BRA",
"website": "https://www.example.com/new",
"legalRepresentativeName": "Jane Doe",
"email": "test@example.com",
"phone": {
"countryCode": "55",
"areaCode": "11",
"number": "999990099"
},
"address": {
"street": "Rua Exemplo",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100",
"number": "200",
"comment": "Sala 1",
"country": "BRA",
"line2": "Sala 100",
"line3": "Torre A"
},
"attributes": {
"emailPixKey": "test@example.com",
"socialMedia": "https://www.linkedin.com/company/example",
"numberOfEmployees": "11-50",
"countryTaxResidence": "BRA",
"sourceOfFundsAndIncome": "sales_of_goods_and_services",
"reasonForAccountOpening": "receive_payments_for_goods_and_services",
"estimatedAnnualRevenueUsd": "1m_to_10m",
"estimatedMonthlyVolumeUsd": "50000",
"businessActivityDescription": "Online retail of home goods. Receives payments from end customers in Brazil via PIX."
},
"documentationStatus": "COMPLETE",
"document": {
"documentId": "91eaf0c8-844b-42a1-a614-304edbcfa57d",
"entityId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "CNPJ",
"id": "00000000000100",
"issuingCountry": "BRA",
"issueDate": null,
"expirationDate": null,
"isPrimary": true,
"status": "VERIFIED",
"metadata": null,
"proofs": [
{
"id": "ab62c0eb-e921-4d78-9887-25aa57c56c94",
"documentId": "91eaf0c8-844b-42a1-a614-304edbcfa57d",
"proofType": "DOCUMENT",
"fileName": "proof_of_address_company.pdf",
"mimeType": "application/pdf",
"sizeBytes": 53248,
"verificationStatus": "APPROVED",
"verifiedBy": "67890",
"verifiedAt": "2024-01-15T17:20:45Z",
"verificationReason": null,
"uploadedBy": "12345",
"uploadedAt": "2024-01-15T17:19:54Z",
"status": "CURRENT",
"supersededAt": null,
"supersededBy": null,
"replacedByProofId": null,
"deletedAt": null,
"deletedBy": null,
"inVerification": false
}
],
"createdAt": "2024-01-15T17:18:53Z",
"updatedAt": "2024-01-15T17:19:26Z"
},
"documents": [
{
"documentId": "a4f9d2ed-c365-4a0b-b775-9278c039af93",
"entityId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "ARTICLES_OF_INCORPORATION",
"id": "ART-00000000000100",
"issuingCountry": "BRA",
"issueDate": null,
"expirationDate": null,
"isPrimary": false,
"status": "VERIFIED",
"metadata": null,
"proofs": [
{
"id": "0b2e18fb-1b61-402c-be80-863735d3fa4d",
"documentId": "a4f9d2ed-c365-4a0b-b775-9278c039af93",
"proofType": "DOCUMENT",
"fileName": "certificate_of_incorporation.pdf",
"mimeType": "application/pdf",
"sizeBytes": 55296,
"verificationStatus": "APPROVED",
"verifiedBy": "67890",
"verifiedAt": "2024-01-15T17:20:43Z",
"verificationReason": null,
"uploadedBy": "12345",
"uploadedAt": "2024-01-15T17:19:52Z",
"status": "CURRENT",
"supersededAt": null,
"supersededBy": null,
"replacedByProofId": null,
"deletedAt": null,
"deletedBy": null,
"inVerification": false
}
],
"createdAt": "2024-01-15T17:18:53Z",
"updatedAt": "2024-01-15T17:19:26Z"
},
{
"documentId": "5ca3e868-2b76-4390-b25a-5d10c0db8516",
"entityId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "TAX_ID",
"id": "00.000.000/0001-00",
"issuingCountry": "BRA",
"issueDate": "2024-01-15",
"expirationDate": "2034-01-15",
"isPrimary": false,
"status": "VERIFIED",
"metadata": {
"tin": "formatted"
},
"proofs": [
{
"id": "13db8888-d5e6-4c47-95ce-1b962a63645c",
"documentId": "5ca3e868-2b76-4390-b25a-5d10c0db8516",
"proofType": "DOCUMENT",
"fileName": "company_tax_identification_document.pdf",
"mimeType": "application/pdf",
"sizeBytes": 53248,
"verificationStatus": "APPROVED",
"verifiedBy": "67890",
"verifiedAt": "2024-01-15T17:20:44Z",
"verificationReason": null,
"uploadedBy": "12345",
"uploadedAt": "2024-01-15T17:19:53Z",
"status": "CURRENT",
"supersededAt": null,
"supersededBy": null,
"replacedByProofId": null,
"deletedAt": null,
"deletedBy": null,
"inVerification": false
}
],
"createdAt": "2024-01-15T17:18:54Z",
"updatedAt": "2024-01-15T17:19:32Z"
}
],
"version": 3,
"createdAt": "2024-01-15T17:18:53Z",
"updatedAt": "2024-01-15T17:19:26Z",
"customFieldSchemaVersion": 9,
"uboCount": 2,
"uboRequirementMet": true
}{
"type": "about:blank",
"title": "Validation error",
"status": 400,
"detail": "A field, header, path or query parameter is missing, unknown or invalid. details[] lists field and issue.",
"instance": "/api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"code": "VALIDATION_ERROR",
"correlationId": "0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10",
"details": [
{
"field": "externalId",
"issue": "REQUIRED"
}
]
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid access token.",
"instance": "/api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"code": "UNAUTHORIZED",
"correlationId": "0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10",
"details": []
}{
"type": "about:blank",
"title": "Not found",
"status": 404,
"detail": "The entity does not exist or belongs to another merchant.",
"instance": "/api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"code": "ENTITY_NOT_FOUND",
"correlationId": "0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10",
"details": []
}Devuelve la entidad completa: datos de KYC, documentos declarados con sus pruebas activas, estados derivados y, para una COMPANY, el resumen de UBO.
- El ejemplo es una COMPANY con dos propietarios vinculados: uboCount: 2, uboRequirementMet: true.
- Las entidades CLOSED siguen siendo accesibles por id.
- Un entityId que no sea UUID devuelve 400.
application/problem+json con un code estable. Catálogo completo: Estados de entidad y códigos de error.Autorizaciones
Encabezados
Token de acceso Bearer para la autenticación. Este token se obtiene de los endpoints Get Access Token o Refresh Access Token. Tu cuenta de comerciante y el usuario que actúa se determinan a partir de él.
Ejemplo:
"Bearer <your_access_token>"
Parámetros de ruta
Respuesta
OK.
Última modificación el 10 de noviembre de 2026

