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
}
实体
创建实体
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
}
注册自然人(INDIVIDUAL)或法人实体(COMPANY)及其身份证明文件。实体将以 PENDING_KYC 状态创建,且不含文件;之后请通过“上传证明”上传支持文件。
- 创建时会验证最低 KYC 数据:INDIVIDUAL 需提供 name 和 lastname,COMPANY 需提供 name。否则 API 将返回 422 INCOMPLETE_KYC_DATA。
- 未知属性将被拒绝,并返回 400 VALIDATION_ERROR。任何额外数据请放入 attributes。
- 国家/地区代码必须为 ISO 3166-1 alpha-3 格式(BRA,而不是 BR)。
- 税务 ID(CPF、CNPJ、CUIT、RFC 等)是一种文件,而不是实体的字段。请在 document 中发送;创建时不接受 documents[](400 VALIDATION_ERROR)。
- 其他文件(身份证件、地址证明、公司章程)请通过“添加文件”添加。
- 请保留响应中的 document.documentId:它是用于向主文件上传文件的 docId。
code 的 application/problem+json。完整目录:实体状态和错误代码。授权
请求头
请求体
application/json
响应
已创建。
最后修改于 2026年11月10日

