Person Creation

POST /v1/api/people/create

This API endpoint allows the creation of people. It enables clients to create person information based on specific criteria provided in the request payload.

Clients can send a POST request to this endpoint with appropriate parameters, including details such as personal data, address and client data.

The endpoint ensures flexibility by allowing optional parameters to be included, such as special loyalty program details.

Upon successful person creation, the client application will receive a confirmation response containing the created person ID.

In case of errors or conflicts during person creation, the response structure is designed to provide detailed information on the issue encountered, facilitating efficient error handling and resolution.

Request

application/json

Body

firstName stringnullable

Nome.

lastName stringnullable

Sobrenome.

email stringnullable

Email.

phone stringnullable

Telefone.

cpf stringnullable

CPF.

passport stringnullable

Passaporte.

dob stringnullable

Data de nascimento.

country stringnullable

País de origem.

registrationSource stringnullable

Origem de cadastro.

addressStreetName stringnullable

Rua.

addressNumber stringnullable

Número.

addressZipCode stringnullable

CEP.

addressAdditionalInformation stringnullable

Complemento.

addressDistrict stringnullable

Bairro.

addressCity stringnullable

Cidade.

addressState stringnullable

Estado.

ageGroup nullable

Possible values: [ADULT, CHILD, null]

Adulto ou criança.

loyaltyLevel stringnullable

Nível fidelidade.

loyaltyOptIn booleannullable

Opt-in fidelidade.

Responses

CreatePersonResponse()

application/json

Schema
Example (from schema)

Schema