Skip to main content

Get Tax ID Document Status

GET https://api-sandbox.letpay.io/identityValidation/CONTRACT_ID/BR/TAX_ID

Retrieve Identity Validation Data​

This endpoint makes an HTTP GET request to retrieve identity validation data for a specific contract, country, and tax ID.

Supported Countries and IDs:​

  • Brazil: CPF, CNPJ

Request​

  • Path Parameters
  • CONTRACT_ID (string): The ID of the contract for which identity validation data is being retrieved.
  • BR (string): The country code for Brazil.
  • TAX_ID (string): The tax identification number for the individual.

Response​

The response for this request will be a JSON object containing the identity validation data. To document the response as a JSON schema, the following properties can be included:

  • property1 (type): Description of property1.
  • property2 (type): Description of property2.
  • ...

Please note that the actual properties and their descriptions will depend on the structure of the response data.

Authorization​

AUTHORIZATIONAPI Key
KeyX-Auth-Token
ValueMY_ACCESS_TOKEN

Example Request​

Example Request​

200 - Valid Document
    curl --location 'https://api-sandbox.letpay.io/identityValidation/CONTRACT_ID/BR/12345678909'

Example Response​

Header
  Content-Type: application/json
Body
    {
      "document": "12345678909",
      "status": "VALID_DOCUMENT"
    }