Skip to main content

Person Retrieval by CPF

GET 
/v1/api/people/cpf/:cpf

This endpoint retrieves an existing person by their CPF document number.

Upon successful retrieval, the response will contain the person's personal details, address data, and loyalty information.

In case of errors or if the requested person is not found, the response structure is designed to provide appropriate error messages, facilitating efficient error handling and resolution.

Request​

Path Parameters

    cpf stringrequired

Responses​

Successful retrieval.

Schema
    firstName stringnullable

    First 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

    Address 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

    Person ID.

    creationDate stringnullable

    Creation date.

    enabled booleannullable

    Default value: true

    Whether the person is enabled or not.

    loyaltyData object[]

    List of loyalty programs.

  • Array [
    • id stringnullable

    Loyalty program ID.

    alias stringnullable

    Loyalty program alias.

    balance floatnullable

    Balance.

    nextExpirationAt stringnullable

    Next expiration date.

    nextExpirationValue floatnullable

    Next expiration value.

    tier stringnullable

    Loyalty tier.

  • ]
Loading...