Skip to content

Institution API

Get Institution Encoding Key

Fetches for Institution Encoding Key by institution_id.

plaintext
POST /api/v2/getInstitutionKey

Request Parameters

Body ParametersTypeRequiredDescription
institution_idstringYESUUIDv4 String for institution_id

Success Response

json
{
    "response": {
        "id": "SOME_UUID_V4_STRING",
        "name": "key",
        "domain": "soa",
        "category": "general",
        "contentMediaType": 1,
        "value": "${ENCODING_KEY_HERE}$",
        "description": "SOA institution encoding key. ex: A1B2C3D4E5F601020910"
    },
    "exception": null
}