curl --request POST \
--url https://api.stage.localpayment.com/api/entity/v1/entities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"type": "INDIVIDUAL",
"name": "Jane",
"lastname": "Doe",
"birthdate": "1990-01-15",
"nationality": "BRA",
"birthCountry": "BRA",
"residenceCountry": "BRA",
"isPep": false,
"email": "jane.doe@example.com",
"phone": {
"countryCode": "55",
"areaCode": "11",
"number": "999990001"
},
"address": {
"street": "Rua Exemplo",
"number": "123",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100",
"country": "BRA"
},
"document": {
"type": "CPF",
"id": "00000000000",
"issuingCountry": "BRA"
}
}
'
{
"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
}
Entidades
Criar uma entidade
POST
/
api
/
entity
/
v1
/
entities
curl --request POST \
--url https://api.stage.localpayment.com/api/entity/v1/entities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"type": "INDIVIDUAL",
"name": "Jane",
"lastname": "Doe",
"birthdate": "1990-01-15",
"nationality": "BRA",
"birthCountry": "BRA",
"residenceCountry": "BRA",
"isPep": false,
"email": "jane.doe@example.com",
"phone": {
"countryCode": "55",
"areaCode": "11",
"number": "999990001"
},
"address": {
"street": "Rua Exemplo",
"number": "123",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100",
"country": "BRA"
},
"document": {
"type": "CPF",
"id": "00000000000",
"issuingCountry": "BRA"
}
}
'
{
"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
}
Registra uma pessoa física (INDIVIDUAL) ou uma pessoa jurídica (COMPANY) com seu documento de identificação. A entidade é criada com status PENDING_KYC e sem arquivos; envie os arquivos de apoio depois com Enviar uma Prova.
- Os dados mínimos de KYC são validados na criação: name e lastname para INDIVIDUAL, name para COMPANY. Caso contrário, a API retorna 422 INCOMPLETE_KYC_DATA.
- Propriedades desconhecidas são rejeitadas com 400 VALIDATION_ERROR. Coloque quaisquer dados adicionais em attributes.
- Os códigos de país devem estar em ISO 3166-1 alpha-3 (BRA, não BR).
- Um identificador fiscal (CPF, CNPJ, CUIT, RFC, …) é um documento, não um campo da entidade. Envie-o em document; documents[] não é aceito na criação (400 VALIDATION_ERROR).
- Adicione os demais documentos (documento de identidade, comprovante de endereço, contrato social) com Adicionar um Documento.
- Guarde document.documentId da resposta: é o docId usado para enviar arquivos ao documento principal.
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>"
Corpo
application/json
Resposta
Criado.
Última modificação em 10 de novembro de 2026

