Person Retrieval by CPF

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

Returns a person by CPF, with personal data, address and loyalty wallets (loyaltyData). The lookup is an exact match, so send the CPF in the same format it was stored in.

Request

Path Parameters

cpf stringrequired

Responses

200

Successful retrieval.

application/json

Schema

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).

loyaltyTier stringnullabledeprecated

Legacy field, no longer updated. Read the person's levels from loyaltyData[].tier.

loyaltyOptIn booleannullabledeprecated

Legacy flag. It does not tell whether the person opted into a loyalty program.

id stringnullable

Person ID.

creationDate stringnullable

Creation date.

enabled booleannullable

Default value: true

Whether the person is enabled or not.

loyaltyData object[]
The person's loyalty wallets, with balance and level.
Array [
id stringnullable
ID of the loyalty credential that holds the wallet.
alias stringnullable
Credential alias, or its ID when it has no alias.
balance floatnullable
Balance.
nextExpirationAt stringnullable
Date of the next balance expiration.
nextExpirationValue floatnullable
Amount that expires on nextExpirationAt.
tier stringnullable
The person's level in this wallet. For a manual loyalty credential, it is the level set with loyaltyTier.
]

Example (from schema)

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "cpf": "string",
  "passport": "string",
  "dob": "string",
  "country": "string",
  "registrationSource": "string",
  "addressStreetName": "string",
  "addressNumber": "string",
  "addressZipCode": "string",
  "addressAdditionalInformation": "string",
  "addressDistrict": "string",
  "addressCity": "string",
  "addressState": "string",
  "id": "string",
  "creationDate": "string",
  "enabled": true,
  "loyaltyData": [
    {
      "id": "string",
      "alias": "string",
      "balance": 0,
      "nextExpirationAt": "string",
      "nextExpirationValue": 0,
      "tier": "string"
    }
  ]
}

404

No person with this CPF in the tenant.

application/json

Schema

Schema

errorCode integer
errorMessage string

What went wrong, in Portuguese.

errorType string
errorData object

Always empty in this API.

Example (from schema)

{
  "errorCode": 404,
  "errorMessage": "string",
  "errorType": "AmazingNiaraException",
  "errorData": {}
}

Example

{
  "errorCode": 404,
  "errorMessage": "Pessoa com CPF 52998224725 não encontrada",
  "errorType": "AmazingNiaraException",
  "errorData": {}
}

Loading...