Listar entidades
curl --request GET \
--url https://api.stage.localpayment.com/api/entity/v1/entities \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stage.localpayment.com/api/entity/v1/entities"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stage.localpayment.com/api/entity/v1/entities")
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{
"pageIndex": 0,
"pageSize": 20,
"totalElements": 1,
"totalPages": 1,
"content": [
{
"internalId": "5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"type": "INDIVIDUAL",
"status": "PENDING_KYC",
"name": "Jane",
"lastname": "Doe",
"birthdate": "1990-01-15",
"gender": null,
"nationality": "BRA",
"birthCountry": "BRA",
"residenceCountry": "BRA",
"occupation": null,
"isPep": false,
"incorporationDate": null,
"incorporationCountry": null,
"website": null,
"legalRepresentativeName": null,
"email": "jane.doe@example.com",
"phone": {
"countryCode": "55",
"areaCode": "11",
"number": "999990001"
},
"address": {
"street": "Rua Exemplo",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100",
"number": "123",
"comment": null,
"country": "BRA",
"line2": null,
"line3": null
},
"attributes": null,
"documentationStatus": "NO_FILES",
"document": {
"documentId": "2e16d844-4fa9-4295-9a21-83ec32ef241a",
"entityId": "5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"type": "CPF",
"id": "00000000000",
"issuingCountry": "BRA",
"issueDate": null,
"expirationDate": null,
"isPrimary": true,
"status": "PENDING",
"metadata": null,
"proofs": [],
"createdAt": "2024-01-15T17:03:10Z",
"updatedAt": "2024-01-15T17:03:10Z"
},
"documents": [],
"version": 0,
"createdAt": "2024-01-15T17:03:10Z",
"updatedAt": "2024-01-15T17:03:10Z",
"customFieldSchemaVersion": null
}
]
}{
"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",
"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",
"code": "UNAUTHORIZED",
"correlationId": "0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10",
"details": []
}Entidades
Listar entidades
GET
/
api
/
entity
/
v1
/
entities
Listar entidades
curl --request GET \
--url https://api.stage.localpayment.com/api/entity/v1/entities \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stage.localpayment.com/api/entity/v1/entities"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stage.localpayment.com/api/entity/v1/entities")
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{
"pageIndex": 0,
"pageSize": 20,
"totalElements": 1,
"totalPages": 1,
"content": [
{
"internalId": "5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"type": "INDIVIDUAL",
"status": "PENDING_KYC",
"name": "Jane",
"lastname": "Doe",
"birthdate": "1990-01-15",
"gender": null,
"nationality": "BRA",
"birthCountry": "BRA",
"residenceCountry": "BRA",
"occupation": null,
"isPep": false,
"incorporationDate": null,
"incorporationCountry": null,
"website": null,
"legalRepresentativeName": null,
"email": "jane.doe@example.com",
"phone": {
"countryCode": "55",
"areaCode": "11",
"number": "999990001"
},
"address": {
"street": "Rua Exemplo",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100",
"number": "123",
"comment": null,
"country": "BRA",
"line2": null,
"line3": null
},
"attributes": null,
"documentationStatus": "NO_FILES",
"document": {
"documentId": "2e16d844-4fa9-4295-9a21-83ec32ef241a",
"entityId": "5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"type": "CPF",
"id": "00000000000",
"issuingCountry": "BRA",
"issueDate": null,
"expirationDate": null,
"isPrimary": true,
"status": "PENDING",
"metadata": null,
"proofs": [],
"createdAt": "2024-01-15T17:03:10Z",
"updatedAt": "2024-01-15T17:03:10Z"
},
"documents": [],
"version": 0,
"createdAt": "2024-01-15T17:03:10Z",
"updatedAt": "2024-01-15T17:03:10Z",
"customFieldSchemaVersion": null
}
]
}{
"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",
"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",
"code": "UNAUTHORIZED",
"correlationId": "0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10",
"details": []
}Retorna uma lista paginada das suas entidades. Entidades encerradas são excluídas, a menos que includeClosed=true.
- Valores de enum inválidos nos filtros retornam 400 VALIDATION_ERROR.
- A filtragem por nome não está disponível.
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 consulta
Resposta
OK.
Última modificação em 10 de novembro de 2026

