Sign in
Key

Create Key

Creates a Key.

post/v1/clients/{ClientID}/keys

Path parameters

ClientIDstring required

22-character ClientID. Present in your credential file. Ask boarding/support if you need to specify a SubClientID.

Request body

formatstring required

Public Key Response Format, either:

  • ASN.1
  • Raw (Modulus and Public Exponent)

Example request

{
  "format": "ASN.1"
}

Response

A Key is created.

SCinteger

HTTP Status Code

ECstring

Internal Error Code. This is used to help TabaPay team members trace an error.

EMstring

Short description of the error if an error occurred.

keyIDstring

22 character KeyID

keystring

ASN.1 encoded in Base64 URL-Safe Character Set

Only present if format is ASN.1

keyModulusstring

Modulus, encoded in Base64 URL-Safe Character Set

Only present if format is Raw

keyExponentstring

Public Exponent, encoded in Base64 URL-Safe Character Set

Only present if format is Raw

expirationstring

Key Expiration in yyyy-MM-ddTHH:mm:ssZ Format.

noticesstring

Important Notices

Example response

{
  "keyID": "TabaPay_KeyID_22_chars"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.