Get verification key

This endpoint will return a JSON Web Key (JWK) needed to validate our webhook messages when provided with the Key ID.

Get verification key

Retrieve the indicated verification Key for validating a webhook message

GEThttps://api.finlink.vumi.io/api/v1/webhook_verification/{keyId}

Authorization

bearerAuth

Path parameters

keyId*string (uuid)

ID for the key to be retrieved

Response

200401404500

Successfully retrieved verification key

Body

application/json

xstring

The x coordinate for the elliptic curve point. This is encoded using Base64

ystring

The y coordinate for the elliptic curve point. This is encoded using Base64

algstring

The crypthographic algorithm family used with the key. In our case, ES256

crvstring

Identifies the cryptographic curve used. For ES256, this is P-256

ktystring

Identifies the cryptographic algorithm family used with the key. For ES256, this is EC

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.finlink.vumi.io/api/v1/webhook_verification/{keyId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

{
  "x": "text",
  "y": "text",
  "alg": "text",
  "crv": "text",
  "kty": "text"
}