Create an Entity

post

https://api.stage.localpayment.com/api/entity/v1/entities

Registers a natural person (INDIVIDUAL) or a legal entity (COMPANY) with its identifying document.

Body Params

externalId

string

required

Your own identifier for the entity. Unique per merchant, 1 to 64 characters.

type

string

enum

required

INDIVIDUAL (natural person) or COMPANY (legal entity).

Allowed:

name

string

required

First name (INDIVIDUAL) or legal name (COMPANY). Up to 255 characters.

lastname

string

Last name. Required for INDIVIDUAL. Up to 255 characters.

birthdate

date

YYYY-MM-DD. Recommended for INDIVIDUAL.

gender

string

enum

MALE, FEMALE, OTHER or UNDISCLOSED.

Allowed:

nationality

string

ISO 3166-1 alpha-3 (BRA, ARG, MEX).

birthCountry

string

ISO 3166-1 alpha-3.

residenceCountry

string

ISO 3166-1 alpha-3. For a COMPANY, country of tax residence.

occupation

string

Occupation of the person. Up to 100 characters.

isPep

boolean

Politically exposed person. Default false.

incorporationDate

date

YYYY-MM-DD. COMPANY only.

incorporationCountry

string

ISO 3166-1 alpha-3. COMPANY only.

website

string

Company website. Up to 255 characters.

legalRepresentativeName

string

Name of the legal representative (COMPANY). Up to 255 characters.

string

Contact email. Up to 255 characters.

phone

object

Contact phone, digits only in each part.

address

object

Postal address. When sent, country is required.

attributes

object

Custom fields defined by your custom-fields schema (see Custom Fields). Up to 64 KB.

document

object

required

The identifying document of the entity (tax ID or identity document). It becomes the primary document. Other documents are added afterwards with Add a Document.

Headers

X-Correlation-ID

string

Trace identifier (UUID). Echoed in the response; generated by Localpayment if absent.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Created.

400Bad Request. VALIDATION_ERROR: A field, header, path or query parameter is missing, unknown or invalid. details[] lists field and issue. CUSTOM_FIELDS_INVALID: attributes does not satisfy your custom-fields schema. details[] lists field and issue.

401Unauthorized. UNAUTHORIZED: Missing or invalid access token.

409Conflict. DUPLICATE_ENTITY: externalId, or the pair type + id of a document, already exists in your merchant.

413Payload Too Large. PAYLOAD_TOO_LARGE: attributes exceeds 64 KB.

415Unsupported Media Type. UNSUPPORTED_MEDIA_TYPE: The request Content-Type is not the one the endpoint expects (application/json, or multipart/form-data for uploads).

422Unprocessable Entity. INCOMPLETE_KYC_DATA: Minimum KYC data is missing: name and lastname for INDIVIDUAL, name for COMPANY.