Retrieve Key

Retrieves the Key.

URL

https://<FQDN>/v1/clients/<ClientID>/keys/<KeyID>
https://<FQDN>/v1/clients/<ClientID>/keys/<KeyID>?Format=ASN.1
https://<FQDN>/v1/clients/<ClientID>/keys/<KeyID>?Format=Raw

Request:

No Request Data

Response:

Status Codes:

Status Code Description
200 OK The Key is returned.

See Status Codes for other possible Status Codes that might be returned.

Response Data:

JSON Name Value Description Status Code
ASN.1 Raw Other
200 200
SC Integer
3-digit code		 HTTP Status Code ✔ ✔ O
EC String
1 or 8 characters		 Internal Error Code ✔ ✔ O
EM String Error Message O
key String ASN.1
encoded in Base64 URL-Safe Character Set		 ✔
keyModulus String Modulus
encoded in Base64 URL-Safe Character Set		 ✔
keyExponent String Public Exponent
encoded in Base64 URL-Safe Character Set		 ✔
expiration String Key Expiration in yyyy-MM-ddTHH:mm:ssZ Format. ✔ ✔

Sample responses:

Key returned in ASN.1 format:
{
  "SC": 200,
  "EC": "0",
  "keyID": "TabaPay_KeyID_22-chars",
  "key": "Base64_Encoded_Key",
  "expiration": "2017-04-03T00:00:00Z"
}

-----------
Key returned in Raw format:
{
  "SC": 200,
  "EC": "0",
  "keyID": "TabaPay_KeyID_22-chars",
  "keyModulus": "Base64_Encoded_Modulus",
  "keyExponent": "Base64_Encoded_Exponent",
  "expiration": "2017-04-03T00:00:00Z"
}

Notes:

The default Format is Raw.