v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Government Identifier Endpoints

gcm/government-identifier/add

Add a new government identifier for a certain client account and corridor.

post/gcm/government-identifier/add

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

GovernmentIdentifierSchemastring required

The government identifier schema

IDNumberstring required

The ID number

ClientAccountIDstring

The client account ID

RecipientContactIDstring

The recipient contact ID

Countrystring

The country

ExpirationDatestring

The expiration date

IssueDatestring

The issue date

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Error message if any

GovernmentIdentifierTokenstring

The token of the added government identifier

ClientAccountIDstring

The client account ID

Example response

{
  "GovernmentIdentifierToken": "3543e6ecak8wk3770pd32kv2c37tsl5kcfpyck3u9zl6dx2h2c42ia0428n96g44",
  "ClientAccountID": "test_account"
}