Introduction

The LATAM Pass Member PNA API is the way through which our partners can access the data of our LATAM Pass members in accordance with the Personal Data Protection Laws of the countries in which we operate and having been considered essential for the proper operation of the partnership.

To be able to make requests to the API, you must first obtain the access token. See the Authentication documentation for full information.

Request

There are three possibilities to search for a member:

  1. Only by the LATAM Pass member identification code or Frequent Flyer Number ( ffn);
  2. Only by the identification document data ( document);
  3. First by ffnand then by document.
  • client_id: value obtained from the Dev Tools > My Apps > Client ID menu and mandatory in all requests
  • access_token: access token previously obtained
  • x-scope: list of scopes separated by comma (,)
  • x-latam-test: fixed LatamPass, to be used in the test environment only, which means, it must not be used in the production environment

Scopes

Member data will be returned if, and only if, it is essential for the proper operation of the partnership. If it is considered personal or sensitive, it must be consented by the member and supported by contract and/or terms and conditions of the program or partnership, to be defined by Data Protect .

  • Generics:
    • member-balance: redeemable points account balance
    • member-coalition: program coalition
    • member-enrollment: date of registration in the program
    • member-language: member language(s)
    • member-segment: segment(s) linked to the account
    • member-status: account status
    • member-tier: category in the program and its expiration date
  • Personal or sensitive:
    • member-address: member address(es), residential and/or business
    • member-birthdate: member's date of birth
    • member-document: document(s) linked to the account
    • member-email: email address(es) linked to the account
    • member-gender: member gender
    • member-marital: member's marital status
    • member-name: member names
    • member-nationality: member nationality
    • member-phone: member's telephone number(s), landline and/or mobile

Response

Most common errors

Invalid scopes or not defined for client

{
  "error": {
    "code": "INVALID_SCOPE",
    "message": "Invalid scopes [member-xx], The provided scope is not allowed.",
    "instructions": "Contact Latam team, to get allowed scopes."
  }
}

No member was found with the information provided

"error": {
   "code": "MEMBER_NOT_EXISTS",
   "message": "MemberDoesNotExist: Member does not exist.",
   "instructions": "Try with other FFN",
   "issuedDateTime": "2024-10-21T18:38:00.101662Z",
   "details": null
}

Missing required fields or invalid values

"error": {
    "code": "METHOD_ARGUMENT_NOT_VALID",
    "message": "MethodArgumentNotValid: Invalid request for one or more fields",
    "instructions": "Please see the details and retry the request",
    "issuedDateTime": "2024-10-21T18:55:08.950649Z",
    "details": {
        "member.ffn": "must not be null"
    }
}

Technical documentation

Click here to access it.