Skip to main content

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​

Body

    firstName stringnullable

    Name.

    lastName stringnullable

    Last name.

    email stringnullable

    Email.

    phone stringnullable

    Phone.

    cpf stringnullable

    CPF.

    passport stringnullable

    Passport.

    dob stringnullable

    Date of birth.

    country stringnullable

    Country of origin.

    registrationSource stringnullable

    Registration source.

    addressStreetName stringnullable

    Street.

    addressNumber stringnullable

    Addresss number.

    addressZipCode stringnullable

    Zip code.

    addressAdditionalInformation stringnullable

    Address complement.

    addressDistrict stringnullable

    Neighborhood.

    addressCity stringnullable

    City.

    addressState stringnullable

    State.

    ageGroup nullable

    Possible values: [ADULT, CHILD, null]

    Classification of the age group (Adult or Child).

    loyaltyLevel stringnullable

    Loyalty level.

    loyaltyOptIn booleannullable

    Loyalty opt-in.

Responses​

CreatePersonResponse()

Schema
    firstName stringnullable

    Name.

    lastName stringnullable

    Last name.

    email stringnullable

    Email.

    phone stringnullable

    Phone.

    cpf stringnullable

    CPF.

    passport stringnullable

    Passport.

    dob stringnullable

    Date of birth.

    country stringnullable

    Country of origin.

    registrationSource stringnullable

    Registration source.

    addressStreetName stringnullable

    Street.

    addressNumber stringnullable

    Addresss number.

    addressZipCode stringnullable

    Zip code.

    addressAdditionalInformation stringnullable

    Address complement.

    addressDistrict stringnullable

    Neighborhood.

    addressCity stringnullable

    City.

    addressState stringnullable

    State.

    ageGroup nullable

    Possible values: [ADULT, CHILD, null]

    Classification of the age group (Adult or Child).

    loyaltyLevel stringnullable

    Loyalty level.

    loyaltyOptIn booleannullable

    Loyalty opt-in.

    id stringnullable
    creationDate stringnullable
    enabled booleannullable

    Default value: true

Loading...