v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Government Identifier Endpoints

gcm/government-identifier

Get a list of all the stored government identifiers for a certain client account and corridor.

get/gcm/government-identifier

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

CorridorIDstring required

The corridor ID

ClientAccountIDstring

The client account ID

RecipientContactIDstring

The recipient contact ID

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Error message if any

Example response

{
  "GovernmentIdentifiers": {
    "0": {
      "CorridorID": "12",
      "GovernmentIdentifierToken": "26aeyllfka4kg2yksbyyj20cgc18wjwgip7t95qem9af3mzhxul344nfvm0ka2o0",
      "GovernmentIdentifierType": "Passport Number",
      "IDNumber": "2147******",
      "ExpirationDate": "2019-05-01",
      "IssueDate": "2011-07-12",
      "IssuingCountry": "Canada",
      "IssuingAbbreviation": "CA",
      "IssuingCountryCode": "CAN"
    }
  }
}