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
Crear una entidad
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 una persona física (INDIVIDUAL) o una persona jurídica (COMPANY) con su documento de identificación. La entidad se crea con estado PENDING_KYC y sin archivos; sube los archivos de respaldo posteriormente con «Subir una prueba».
- Los datos mínimos de KYC se validan en la creación: name y lastname para INDIVIDUAL, name para COMPANY. De lo contrario, la API devuelve 422 INCOMPLETE_KYC_DATA.
- Las propiedades desconocidas se rechazan con 400 VALIDATION_ERROR. Incluye cualquier dato adicional en attributes.
- Los códigos de país deben ser ISO 3166-1 alpha-3 (BRA, no BR).
- Un identificador fiscal (CPF, CNPJ, CUIT, RFC, …) es un documento, no un campo de la entidad. Envíalo en document; documents[] no se acepta en la creación (400 VALIDATION_ERROR).
- Agrega los demás documentos (documento de identidad, comprobante de domicilio, acta constitutiva) con «Agregar un documento».
- Conserve document.documentId de la respuesta: es el docId que se usa para subir archivos al documento principal.
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>"
Cuerpo
application/json
Respuesta
Creado.
Última modificación el 10 de noviembre de 2026

