PhenixID DocumentationPhenixID Signing ServicesPhenixID Signing Service Developer integration guideUsing Local signing - API - Transaction (text) signing using Freja eID

Using Local signing - API - Transaction (text) signing using Freja eID

Overview

To use the API, two methods must be called. The first API method call is to trigger the signing. This will return a signing reference alue. The second API method call will poll the status of the signing. The API client must poll until a status=APPROVED, CANCELLED or EXPIRED is returned.

This API is a proxy to the Freja eID signing api. Please view this documentation for details.

Prerequisites

- PhenixID Signing Service Local Signing API configured

- Freja eID mobile app

- Freja eID enrolled

- If PhenixID Signing Service Local Signing API is protected with client certificate authentication: Client certificate (p12)

- If PhenixID Signing Service Local Signing API is protected with basic authentication: Username and password

Trigger signing - data to be fetched before api call

To trigger signing, the api client must fetch these values:

- The text to be signed.

- The minimum registration level required (minRegistrationLevel).

- Which attributes to be returned in the response (attributesToReturn)

- The userID (this can be SSN or an organizational userID, based on the type of environment to use (freja personal or freja organisation)

- userInfoType (Type of userID)

A detailed instruction about these values and expected values can be found here.

Trigger signing - api call

Request

Method: HTTP PUT

Endpoint: /api/sign/FrejaStartSign

Headers:

Name Value
Mandatory Comment
Content-Type application/json Yes
tenant t1 Yes .Value must be given to you by PhenixID Signing Service admin, it might differ depending on the environment.
Authorization <basic_auth_value> No If applicable, username and password must be given to you by PhenixID Signing Service admin.

Body:

The body must contains a json structure.

{
  "attributesToGet": ".",
  "reqiredRegistrationLevel": ".",
  "userInfoType": ".",
  "visibleDataToSign": ".",
  "userIdentifier": "."
}

 

For json properties details, please view this article.

Example request (Please note that authorization data is not included in this example).

 

PUT /api/sign/FrejaStartSign HTTP/1.1
Host: example.org
Content-Type: application/json
tenant: t1

Cache-Control: no-cache
{
  "attributesToGet": "SSN",
  "reqiredRegistrationLevel": "EXTENDED",
  "userInfoType": "SSN",
  "visibleDataToSign": "U2lnbmVyYSBkZXR0YSBkw6U=",
  "userIdentifier": "1912121212"
}

Response

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3900
{    
     "signRef": "6ar6380HtZ_SmFZ-6TjdHurBdzLScWtmoeYt-hV9tTCGwXINiPTlLfZeC2oyg2L3F"
}

Collect signature - use signing reference

The API client must fetch the signRef returned by the Trigger sign call.

The API client must call the Collect Signature API method periodically until it returns a status APPROVE or CANCELLED/EXPIRED. For a full list of possible statuses, please view the Freja eID documentation.

Collect signature - api call

Request

Method: HTTP PUT

Endpoint: /api/sign/FrejaCollectSign

Headers:

Name Value Mandatory Comment
Content-Type application/json Yes
tenant t1 Yes This value must be given to you by the PhenixID Signing Service admin.
Authorization <basic_auth_value> No Basic authentication username and password must be given to you by PhenixID Signing Service admin.

Body:

The body must contains a json structure.

{"signRef":"..."} 

Json structure properties:

Name Value Mandatory Comment
signRef <Value_returned_from_trigger_sign> Yes

Example request (Please note that authorization data is not included in this example).

PUT /api/sign/FrejaCollectSign HTTP/1.1
Host: example.org
Content-Type: application/json
tenant: t1
Cache-Control: no-cache
{"signRef":"6aert3380HtZ_SmFZ-6TjdHurBdzLScWtmoeYt-hV9tTCGwXINiPTlLfZeC2oyg2L3F"}

Response

Response

The response body JSON contains a number of different properties. For a full explanation of these properties and how to find the actual signature data, please view the Freja eID documentation.

 

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 390010
{
  "organisationIdIdentifier": "",
  "mail": "",
  "givenName": "",
  "fullResponse": "sdfsdfsdfsdfkjhsdfsdhjf UWlPaUpoVW5jNVQweHVNa0pvVFRkb2VHOWpORFU0WTBsWVNHWmxlbmNpTENKaGJHY2lPaUpTVXpJMU5pSjkuZXlKemFXZHVVbVZtSWpvaU5tRjRNemd3U0hSYVgxTnRSbG90TmxScVpFaDFja0prZWt4VFkxZDBiVzlsV1hRdGFGWTVkRlJEUjNkWVNVNXBVRlJzVEdaYVpVTXliM2xuTWt3elJpSXNJbk4wWVhSMWN5STZJa0ZRVUZKUFZrVkVJaXdpZEdsdFpYTjBZVzF3SWpveE5qTXhNREE1TnpVM01qTXpMQ0p0YVc1U1pXZHBjM1J5WVhScGIyNU1aWFpsYkNJNklrVllWRVZPUkVWRUlpd2ljMmxuYm1GMGRYSmxWSGx3WlNJNklsTkpUVkJNUlNJc0luTnBaMjVoZEhWeVpVUmhkR0VpT25zaWRYTmxjbE5wWjI1aGRIVnlaU0k2SW1WNVNuSmhWMUZwVDJsSmQwOVVaekpPVkZWNlRrUkZNazlVUmtST2ExVXlUakJTUms1VVNrWk5hbGsxVW1wT1JsSlVUWHBOUkdSRlVWVk9SMUpWV1RKU1ZGWkZUVVZHUTAxNlFrZEHVNa0pvVF9WR2hHVW10Rk0wNVZSWHBTUlZaR1VYcFpOVWxwZDJsWlYzaHVTV3B2YVZWc1RYbE9WRmxwWmxFdVZUSnNibUp0Vm5sWlUwSnJXbGhTTUZsVFFtdDNObFV1Y25VNVdHWTJOSFJLTUhKc2IySmtkRFY1Y2tOMmJ6UkNhRzV3VlRWMVVITmtkRms1WDJjd2JWRm5Uek4wYlRObVFsOXhYMVV0ZWpWa1dtRTVlWGRZYW1kVldYWk5NVzlzY25WaWIzZDZjbWRZVlhWM01GSk9VM0ZRUTFSUmNYazBNalkwZUcxUkxYcEJlbkpwZHpGaVlqUkNSMVZtYTA5VmMxRllablY0ZFVGWmRHNXJlVjl5Um5SVVRrNUZiMU5mWkRBNWNrUlJiRXRQT0c1TFNuTjJaMlJZTUdGNlVWZzVjVEI2Y25CM2VFdFZaemcwTTIxQlJtMVlWSG96Y3pOTWRuVTFaM2RrVVhwTlZURlNRazFSYVVGS1pHNTJaM0ZEYUhwMmIyNUxhVEF3VTFwNmEwOTVRVjh6Ykc5M1prTkRTbVpDWVZSU05WbFpNV1JqWVRWYVdsa3laMVp6Y1ZndGJqVjJkVjlsTWxKemJXWllhbXhzTnpKaVQyMXROM2h4TkMxbVVYcGhaVGRVVHpCbmFtMTNVSEJVZFhKNGNuaFJiRzV5T1d0aFZtRjRObmt0WkdWaU1IUmZhR2xJT1V4WlgzWmFVbVZSSWl3aVkyVnlkR2xtYVdOaGRHVlRkR0YwZFhNaU9pSk5TVWxVTUZGdlFrRkxRME5GT0c5M1oyaFFSMEpuYTNKQ1owVkdRbEZqZDBGUlJVVm5hRTh6VFVsSlZITjZRME5CVlhWb1pXcENORTFSYzNkRFVWbEVWbEZSUjBWM1NsUlNWRVZWVFVKSlIwRXhWVVZaVWsxTVRsUlZOVTFVUlhkTVZGRTBUVVJaZUVoVVFXSkNaMDVXUWtGdlZFWkdXbXhqYld4NldsZE5aMUp1U214aGJVVm5XbFZzUlVsRlJrTk5VazEzUlZGWlJGWlJVVXhGZDNCUlkyMDVhMlJYVGpCaFZ6bDFUVkk0ZDBoUldVUldVVkZFUlhoYVIyTnRWbkZaVTBKc1UxVlJaMVF3VGxSVlEwSlVZVmRrZFdGWE5XNUhRVGg1VFVSSmVFMUVhM2RPZWtWM1RWUlZNVTR4YjNkbldsRjNaMXBGZDJGVVFVNUNaMnhuYUd0blFscFJUVVZCWjBWR1FVRlJaMGRaV1dGaE9WUklOMVpKVTAxbE1sTTFRVE5NVUVOaldVbEZVa1kwVG1sbVYxTkZNR0o2VW5oSU5HZEZTVVF5VjNwRldVMU9OVkkxYm04eVpsVmxiVVpvWlVKRVlsWjVTa2hhWW5aWmVrOVdlVU4xTlVrNVNubEJhRkZxSzB4SU1IZDBURkp5Yms5RVkybHhVRFJPWlhsclJGcDJiVzlCUVVkQk9IbE5SRWw0VFVScmQwNXFTWGxOZW1Nd1RHVNa0pvVFURnhaMFZTWjFCTmFrRjVUVlJCTlUxRVkzbE5hazB6VGtST1lXOVRWWGRKZWtGb1FtZHJja0puUlVaQ1VXTjNRVkZKUlVaQlVWTk5RelIzVDFSbk0wMVVaM2RPZWxsM1RtcFJlRTFVUlhoTlFUQkhRMU54UjFOSllqTkVVVVZDUTNkVlFVRTBTVUpCVVVKb01rRXZLM1V2ZVN0NWJXVmFjR0ZsVkdWQ1lqZEpiR0ppYUVwdVMwWXJkM2c0VTBwSlNHMHdUR3RtV2pJcmRrdHVOMDVsVEVaNE9GVnFhbkJOV25KcGVVTlZhRWxpYm1wMmJuSmtlWE5uV0d3MVVtMVBSSHBzUTJoMGRXcHBUbGszYWxabk9FMTRXWEpUZWxGb2QwbExXbGxwUldoeE5XSjVlRTlDTlU1WVprWXlaelozUkd0d2FXcFVLMUEwUld4b2QycEtaRXBaY1RSS2MyTm5RWGN4YTJOMlJGSktTSGRvVldWNFJITXZiMlZMYTNaUlNVYzJjR3RLY21NeGNGUk5lazFwY0VZMFNEaGlRVEJ3VEcxWE4zQnNaMW93ZEZWeFVuWXhXSE56ZEhWMlFuWjZNRXRQUnpScloyOTNiM1Z5ZUdWa2NqVjZTMFpZUzBWdVEwVlJjSE40ZG5SbVpVRTFhbEJoYlRCSlVuRktkRzE0WkZOaVlUWkVabXhHYlU1amFVbDNRWGRMWlhsQlVGZHpOQzloYkcxSlNXczJSMU5KZUdvcmVrUnlXWEJLVVdWa1VGbzVZMWxXWjB0SVNubHpRVFF6ZG05SlNWSlVSRU5EUlZWbmQyZG5WV05OU1VsRWFFdEJSRUZuUlVOQmFGRjNaRGw0ZGxOblFVczVkVUl3TVRaUWVEbFRkbWsxZURCRk9YcEJUa0puYTNGb2EybEhPWGN3UWtGUmMwWkJSRUkxVFZGemQwTlJXVVJXVVZGSFJYZEtWRkpVUlZWTlFrbEhRVEZWUlZsU1RVeE9WRlUxVFZSRmQweFVVVFJOUkZsNFNGUkJZa0puVGxaQ1FXOVVSa1phYkdOdGJIcGFWMDFuVW01S2JHRnRSV2RhVld4RlNVVkdRMDFTVFhkRlVWbEVWbEZSVEVWM2NGRmpiVGxyWkZkT01HRlhPWFZOVTBGM1NHZFpSRlpSVVVSRmVHUkhZMjFXY1ZsVFFteFRWVkZuVTFoT2VtUlhiSFZhZVVKRVVWTkNNazFVUVdWR2R6QjVUVVJGZVUxVVZYaE5ha1V6VFdwc1lVWjNNSGxOZWtWNVRWUlZlRTFxUlROTmFteGhUVWhuZUVONlFVcENaMDVXUWtGWlZFRnNUa1pOVWxGM1JXZFpSRlpSVW1oRmQzTXhUbFJyZUUxVVFYUk9SR2QzVG1wRlpFMUNjMGRCTVZWRlEyaE5WVlp0Vm5saFdFNXNXWGxDUjJOdFZuRlpVMEpzVTFWUloxRlZTWGhGZWtGU1FtZE9Wa0pCYzFSRGJFSjVZakpTTVZrelVuQmlNalI0U0hwQlpFSm5UbFpDUVUxVVJtdGFlVnBYY0doSlIxWktVa05DVUZFeFRsRkpSazV3V2pJMWNHSnRZM2RuWjBWcFRVRXdSME5UY1VkVFNXSXpSRkZGUWtGUlZVRkJORWxDUkhkQmQyZG5SVXRCYjBsQ1FWRkVSSEJ3UlZGRlN6RlJObUpYTVRsc2IwMVlXa0pqUlVoSGNYQm9iM0puVDJ4Q1ZXdG5ibEpSU0hSS2FHWkhlRWM1YzNNM1p6bGlNRFpDTVZNd1RERTVWRVE1YXpjMFRXbGxLMnBoYVZwb1kyUTJPWGhzTDA0d09VZzFTMFF6Y1RBMlNXOVllVlpXZUV4WFZEZ3ZWMmhqZUZCRWEzbHJaVmR6UWxoM2EzSlhZMUpqWms0elpHZ3paRWRhUmpCRlJraDRiM1Z1Y1RST1UwOHdkVmhPTkZWU1R5dHNhbTh5VlZGaVdqUmpaVEJITkZCb1IwdFNOMkUyYlVadEwzSnFMM2M1YWxaRU5qWkxjVnBOV1hWWWNVTkZUMGd5SzFwdGNqUnVTakprWVd4cFNVUklZV3BuVDFWVFJYSkxWRWxpVkZoNFZscE1kMGhQTVd0MEsxTXdiVVJFVWt3eFpXUTRaMnB2U1VSdGNEWlRkazR4VWxKR1pIaHNTbXRrV21RMlpsSkpRVXcwYlN0S2NVMXBjazFSV1dsTFpEQkVWMnd3UzIxVVpYcFlVemhPU1ZobWFHVkhhVXh4UlUxbFQweDJTMGRzUldKaVFVWkJaMDFDUVVGSGFtZG5SV0pOU1VsQ1JucEJUMEpuVGxaSVVUaENRV1k0UlVKQlRVTkNjMEYzUkVGWlJGWlNNRlJCVVVndlFrRkpkMEZFUWxsQ1oyZHlRbWRGUmtKUlkwSkJVVkpOVFVWdmQxTkJXVWxMZDFsQ1FsRlZTRTFCUzBkUVIyZ3daRWhDZWs5cE9IWmtNMlF6VEcxYWVWcFhjR2hhVjJ4clRHMU9kbUpUT1RCWHVNa0pvVFmVUbHFXbGhLTUdONU9XMWpiVlp4V1ZkV2NGcEdPWEJqTTA0eFlWYzFibGd5VG1oWU0xbDRURzFPYkdOcVFXWkNaMDVXU0ZOTlJVZEVRVmRuUWxGUlVIbFJNekpxY1VsU0wwRnZORGd6VkVabVFreHhabUY0VlVSQ1NVSm5UbFpJVTBGRlVWUkJMMDFFTUVkRFEzRkdZMGxHTlVGUlNVZE5SRVYzVEhkWlNVdDNXVUpDVVZWSVFXZEZWMGt5YURCa1NFSjZUMms0ZG1RelpETk1iVnA1V2xkd2FGcFhiR3RNYlU1MllsTTVNRmw1T1dwWlV6VnZaRWN4YzAxQ01FZEJNVlZrUkdkUHVNa0pvVFlYwSkNVbVI2Y2tVMEswMXRSV0pFWWpCRlQxaE5jbmMyYTFveFVtSm9SRUZVUW1kT1ZraFRWVVZFUkVGTFFtZG5ja0puUlVaQ1VXTkVRMVJCVGtKbmEzRm9hMmxIT1hjd1FrRlJjMFpCUVU5RFFWbEZRWFpZVGl0M1ozcEVZVmRhUWk5T2FUTkZVVmxxVml0Tk0yTnFaMU1yYXpJMWFXaERSVFlyVTFCRVVWZHhOalpWYVhaVVVrSjNiazF1ZUhwTU4wUmlUR2hvV0dnNGVFVllhVk52TDNaR2JrbEtaRk5vYzJ4VU5XMTVlbWsxVkRGTk1HVTVUSEUyWTNWWU5qSTVlV1JZVWpoRFRVc3dWRXd4T1hSbU1FdFFRaXQyVEU5TWFUa3pabUpUVVZBd1QzWndjRlZEWlhwMmMySlliRFJpVUhRMlYzbDFlbVJqS3pkRlJsVmliRXR6TWtRNVpFcHRVSEZvVTFKc01HTlZaRUpZUkhkcE9FTk1SRlkyVGtveWVYTlFOMVJ4YmxjeVdDOVFXRVl2YzNScE56SkRMME14SzI5VWMwUjNOa05OTWpaTFRXdHNhSEZHVkRGTVoyUmhaV2hNYUhNemIwNUthM05QSzFCMlJWYzRSMVZFUWtONFJsQlNZMEZTUmtFMlJqSjBaSEJuUlZsdWJtRllTRkozV2pkTlZURnBibXhoYVVsbFZscDJjelpOZEcxeVpYbHdOa2xMUWpSWmFVaHdaRmRHSzNkRmNtTldjRWN4TTBFclFqTlpVa3RRYVU1bVprVlZNemhMY2pCb1MzcFVNM1JGU2l0SGFXVjNNa1JxY2tSbk0yeHZPRGhITjNKVk5VUldaelkyYTFaYWVHb3ZWRlJaZWpaVloyVXZTMGQ0VTNKT1ducFJWRTFFTjAxSGJDOUdUWFY1T1dsbVFUbENPRUZxZWtGQ01WVk1XamcwUlRSTE1WbFlVMlJNWVdNMFpWZDZLMlF6VkVSMlRsWlFObHAzWVU1YU5GZ3lTMFZRUmtkTUsyaFZlSGN6TjFaaVNWbEtkM0p6UjJ4RVdYbzJUVWxKUmpsNlEwTkJPU3RuUVhkSlFrRm5TVlZXYURRdmNqWnZPRWgyYzFCRVVtSk1SSEZSTlhkelZ6QktabXQzUkZGWlNrdHZXa2xvZG1OT1FWRkZURUpSUVhka2FrVk1UVUZyUjBFeFZVVkNhRTFEVlRCVmVFaFVRV0pDWjA1V1FrRnZWRVpHV214amJXeDZXbGROWjFKdVNteGhiVVZuV2xWc1JVbEZSa05OVWsxM1JWRlpSRlpSVVV4RmQzQlJZMjA1YTJSWFRqQmhWemwxVFZJd2QwZDNXVVJXVVZGRVJYaFNSMk50Vm5GWlUwSnNVMVZSWjFWdE9YWmtRMEpFVVZOQ01rMVVSVlZOUWtsSFFURlZSVmxTVFV4T1ZGVTFUVlJGZDB4VVVUUk5SRmwzU0doalRrMVVZM2RQUkVGNFRWUkpNRTFFUVRKWGFHTk9UWHBGZDA5RVFYaE5WRWt3VFVSQk1sZHFRalZOVVhOM1ExRlpSRlpSVVVkRmQwcFVVbFJGVlUxQ1NVZEJNVlZGV1ZKTlRFNVVWVFZOVkVWM1RGUlJORTFFV1hoSVZFRmlRbWRPVmtKQmIxUkdSbHBzWTIxc2VscFhUV2RTYmtwc1lXMUZaMXBWYkVWSlJVWkRUVkpOZDBWUldVUldHVNa0pvVFVVkZNUlhkd1VXTnRPV3RrVjA0d1lWYzVkVTFUUVhkSVoxbEVWbEZSUkVWNFpFZGpiVlp4V1ZOQ2JGTlZVV2RUV0U1NlpGZHNkVnA1UWtSUlUwSXlUVlJEUTBGaFNYZEVVVmxLUzI5YVNXaDJZMDVCVVVWQ1FsRkJSR2RuUjFCQlJFTkRRVmx2UTJkblIwSkJUVTVoVERkdVVYaFVLMDlWWkVGMFltNVFaV2hZWVVGMVptTk5jbVpCVEVsd2NpdHFWVU5QTW1vdmVrWmhVbUp2U1ZONVFVMTVSMHhwU1RWalZTczBkRmhVU21OVlpWWnlZM1kzUmtoWmJtUnZOMWN5TjNOWlIwRlhhMUZwZW01YVIzUTBabkF6VkRSaU1YSkdLemswU0ZaWk1sWmhlWGRRTkRsWFNsTTROMDUyUkdRMFNHMXJMME56VVVoMVV6Uk5ZVGw2YWpkRVIxTjFkSFJoTlUwclNqTk5PVUpVYld4elZqVnJSU3R1VGxaTVVGTk5XRTV2TW5kRWVYaFlXR3N6UzBWUlpUUmFVVlpsU2s0MlQxRjRla2czZUdRd1NGbzNUVmxoUjNWME0wSm1iRGsyUWt0Q1JVeEtWbEYyTDJWQ2VHNVliMDFPYjBveGVUVlNaRlJNVTBKYVlVVmhiREZJWXpGc2R6WXlZbVpwZEVGRUwweElWRzU2V1RsWlUxZFZSRmhKVDBvMUx6TTFTMGRaU1N0VFNUQnVTRVkzZGtZeFRXZzVOa2RwVUd0UmJHSnRZaXM1ZEVsSFJFWk1aMEpwY1dJelRuUkVhVEJaYW5ORFExRkNiMDVRTDNaQ2VIQllORkJLTTJoek9EVmljWEp1V2l0bE5tb3pTazF5UkZscE9FUm5PSGcxT0hoVU5rUmxVVVJSVG5OVWRsY3hSMUV6YkhkUk9WQm9iMEp1Ukd4SGJrbG5jSGx0VVZwR1EyMTRTMG81TDI5UVpWTjJjVXBOTlVoWFRFOTNla012VTFJdlNub3Zla2gxTmpZdmVEQlJSMEpGUVhSREwzbFJiRXQ1ZVZrMk5rWmxabU5OWTAxd1pHUkNWa05rWVc5VGRreEpjbFIzVEZkUk9VUjNTVVJCVVVGQ2J6UklOVTFKU0RKTlFUUkhRVEZWWkVSM1JVSXZkMUZGUVhkSlFrSnFRVk5DWjA1V1NGSk5Ra0ZtT0VWRFJFRkhRVkZJTDBGblJVRk5RamhIUVRGVlpFbDNVVmxOUW1GQlJreFNlV1J6V2s5SlJrMTZhWEI2T1UweWJYSklSVmxWVFRKUWFrMUZaMGRCTVZWa1NVRlNRazFFT0hkUVVWbEpTMjlXZDJkWWEwSkJVVVYzVFZSQmRrSm5aM0pDWjBWR1FsRmpRMEZTV1dwaFNGSXdZMGhOTmt4NU9UTmtNMk4xV201S2JHRnRSbXhoVjFGMVdUSTVkRXd6VW1wTU1rNW9URzFvTUdKWGQzZFNaMWxFVmxJd1prSkVPSGRRVkVFM2IwUnRaMDQwV1RGaFNGSXdZMGhOTmt4NU9UTmtNMk4xV201S2JHRnRSbXhoVjFGMVdUSTVkRXd6VW1wTU1rNTVZa2hOZGxwdVNteGhiVVpzWVZkU1ptTnRPWFprUmpscVdWTTFhbU50ZDNkSVVWbEVWbEl3VDBKQ1dVVkdRa0V2U2tSbVlVOXZhRWc0UTJwcWVtUk5WamhGZFhBNWNrWlJUVUV3UjBOVGNVZFRTV0l6UkZGRlFrTjNWVUZCTkVsRFFWRkRTMEZYTkNzMkszaFRjbFJvVkZWaVlUSmhlVUo1YUVSUVIySldPRkE0YW5CMWJqY3dOVTE0ZEdnMFpuTTFNWGRpZEU5WlYwUlpTemxuYVdwWk5sbGFNQzlLU1ZWaWEyaHdlbEJsUkV4ME4zVlBZVEZpUXpSSVUyTndPUzlNWldGWWFFdEZWMWRhUlZZdllURXhPREJ1U1VWSVMxTjRZMDB4YTFOT00zaEdXaTlwTkdkaU4xVjJZVGhrVnpOM1ZXMTViMGhpV0daR1pVeDVWVEF2VVVGUlUwVldNSEpJYTNWNlYwNTZXblpoTms5cGFYbEJRVkIyTW5wak1HbGlNV0p5UzNaTEszbEVOVU52U0ZGQmMyVkRZbmhMV21GdFZsWTBZa3hzTWsxUE5rZFViRUl6UkhoalVYaGFUVUo0WWt0V05XNXVaMmxuTUZabVRHMDBjWEZOVTNoQ1FXUnlVRzVQVmxKb1dWQlZkSGhLY2tjeFlUSXhaRTA0WXpGUkswcFZibFYzZDB0YU5IaHRVRGwyTXl0NFEyOUhiak5FYVdNNU1YUTJMMEpWYUdoVGFHRkVOWFl4V2xGVFlrMUtWMkpMVVZaaVpuVkpNR0kyUTNsdGFVMXhWRXh2VTNseVoyaEZZM2RLWWtVd1VsUTVXbmhuUlhabVpWRlJUV3BQTkhKV2NrSjBVMjVXT1VkMlZ6UXdVRlJvZVhOb2RWWTRXRXByTWtrMVZHTjRZVTWRBdHRyaWJ1dGQwWldvdkswRlVSWEZCWlVGVk0yeFlSVmR3TjI1VGMxazFRVVJGVFZJNFZFNVVVbkFyUXpoeWVrZDBLMWxETmxGNFJGSmxOVmQwSzJwalppOTNSbkZFVURNclNsaEVaVWxZVW5FeldXTnlWM2RNVFZoVFFrVjRMMG80UlZCTlduQm9LM2hNWWtWR1psVXdaakppUkdGcVkxTlJMekZGTW5CdFNWWnFNaTg0Tm0xSWVGUnpPRXBVYjBONU9EZEthMmRrVFdseFJYaFhibWg1TldKcVlsQjJOekJzYURWclVHMVNabEZ3TWpsUVFrb3hZVXBVZWs5TllUQkZObEJ1UTJOb2RtcG5iVXRLYW5aMk9YUk5RM29yTW01cVlsZHNXa2wzVjFGV2VDdDVValZNVVRjNGFYQjNaMVJzUTNCeWRrSkxPSFIyWm10RVYyTktTbkZzY2xOUWFrRlNZMmRZZGsxdFVtcERRMEpwYTNkbloxRlNiMEZOUTBGUlNVTkdSVlpYU25VMFlVZFNaVVl3YkM4MGFXZEVaV05hWjJaME5taGxUVUV3UjBOVGNVZFRTV0l6UkZGRlFrTjNWVUZOU0ZsNFEzcEJTa0puVGxaQ1FWbFVRV3hPUmsxU01IZEhkMWxFVmxGUlMwVjRVbGRhV0Vwd1l6Sldha2xGV25sYVYzQm9TVWRXU2xKRFFrSlJha1ZVVFVKRlIwRXhWVVZEZUUxTFZVaEtkbHBJVm1wa1IyeDJZbXBGWkUxQ2MwZEJNVlZGUVhoTlZWSnVTbXhoYlVWbldsVnNSVWxHU25aaU0xRm5VVEJGWjJScVJYaEdSRUZUUW1kT1ZrSkhSVlJEZWxVeFQxUkZlRTFETURCUFJFRXlUVUkwV0VSVVJUTk5SR2QzVFZSRmVFMTZZekZOUm05WVJGUlJNMDFFWjNkTlZFVjRUWHBqTVUxR2IzZGtha1ZNVFVGclIwRXhWVVZDYUUxRFZUQlZlRWhVUVdKQ1owNVdRa0Z2VkVaR1dteGpiV3g2V2xkTloxSnVTbXhoYlVWbldsVnNSVWxGUmtOTlVrMTNSVkZaUkZaUlVVeEZkM0JSWTIwNWEyUlhUakJoVnpsMVRWSXdkMGQzV1VSV1VWRkVSWGhTUjJOdFZuRlpVMEpzVTFWUloxVnRPWFprUTBKRVVWTkNNazFVUlZWTlFrbEhRVEZWUlZsU1RVeE9WRlUxVFZSRmQweFVVVFJOUkZsM1oyZEphVTFCTUVkRFUzRkhVMGxpTTBSUlJVSkJVVlZCUVRSSlEwUjNRWRBdHRyaWJ1dGWGRuWjBsTFFXOUpRMEZSUTJ4M1pXeHlhV0p4YlVwWFZVMHdVakZuVFZKMVJtbFFSbk00UTNSSlprRlBSbVUxYVM5elUzcFNMMWhXZFZaemNFaFRiMmQyVm1weE1rdDBiVEZIUVdWVGFXRklla3czUmtSS05XNUhlbkJ4UlRSNldYQkJWa3g1VUZCQmJWazBjRFp4Vlc1a1JIQkJhRU5DTm5oSWFtRTFVRUYyWWxwRVdDdHlMMDh2V2pkTGNTOWxTbEJpYVZrcmRYVlVjVEJYV1hBMVJURjJiVGhSUm5BeVNXaENPV0pVWVROUU1XODFNVVpzTUdWaFkwZGFkelJVZFVwMk0zcG9kMnRtWkdrd1pWaEVMMk15WlhkM2QxSlVNVFp5VlRFeFJXRXhNSE52WVVZMUwzWTRhV3d2TjIxM1dHcGxSR2cyU3pRd2RUTk5jMEpOT0d0S1NXSXlSV3RwU0RsamNWcG5ObFZpWjJGREwzSkVRMjF4VVdnMFEwdDZNMFp1WjJwRlpFVm9lRmRwYzFFemRGYzJhVEpQWmxScGExaEZVV0UxZFZKSVVGVmFlVmhLZW1zdlFUSmhRVEJMYkdobk1tVm9ja1ZyWW1nMVZuVmpXa2xaWXpZeldsRmxhVFk0VGxkeWVqTkJjamhsVURKVlJYaFRlbTFhZG5NMldtSldRV2gxTUZBNEwxSTRORzlTY0RsSE5tNUxOWFJVTWtOclNtdGhWVFZqU0V0dU5FUlNhbWR4U2pWNlZIQkRNWFUwWm5aTVRYbEZaVTFUUzFVcmFrczJRVWRWTmpjNFJtOTFUbmN5T1N0Vk1FWnRXa1F3VUZSVGFXeEtibEJtUTJwa00wdHVRMHczV1RaNWQwdDVkRm8xVlhaVFltNDVPVXRGU3pGUFNsVkhNelpJWmxSWFYwRjJNVTVPTW5GS01raGxaR1ZOUzJNdk5YTk1WbEphUjFCak1saDZXRFZJZUhCcmMwUkNjMjVJYzFveWQxbGxZazFEUjFkR1REVktjbGhSTW1KQ2VHdzBlVk5NUTBKUkswRkRUMnBVWnpCaU9HdzNORU13VVRWRBdHRyaWJ1dGKdE56WTJiMjEwZEhadVFreDVaak5wUlVORGIxTndka055Tms0eVRuWkpUbUZIVkRkdWFua3lWMXBDV0dsb05XSm5VVGRKUVdKRFUySkxZMmxLVjBJd2REZFBNa2gzV2tsYWMzbG5OVUlyUTFkWGJubzFaalYzU1VSQlVVRkNielJIZFUxSlIzSk5RVFJIUVRGVlpFUjNSVUl2ZDFGRlFYZEpRa0pxUVZCQ1owNVdTRkpOUWtGbU9FVkNWRUZFUVZGSUwwMUNPRWRCTVZWa1NYZFJXVTFDWVVGR1RGSjVaSE5hVDBsR1RYcHBjSG81VFRKdGNraEZXVlZOTWxCcVRVVm5SMEV4VldSSlFWSkNUVVE0ZDFCUldVbExiMVozWjFoclFrRlJSWGROVkVGMlFtZG5ja0puUlVaQ1VXTkRRVkpaYW1GSVVqQmpTRTAyVEhrNU0yUXpZM1ZhYmtwc1lXMUdiR0ZYVVhWWk1qbDBURE5TYWt3eVRtaE1iV2d3WWxkM2QwaFJXVVJXVWpCUFFrSlpSVVpNVW5sa2MxcFBTVVpOZW1sd2VqbE5NbTF5U0VWWlZVMHlVR3BOUVRCSFExTnhSMU5KWWpORVVVVkNRM2RWUVVFMFNVTkJVVUp0U1ZGbWRubEtiemQyVUVaUWEzZGpPVWhZVkhVNVYyMXFkbUZNWVhJM1FVVkNZVlpqUm5kNFJWVTJjMEoxYldZNU0xWXhSMWRHYldvNVRtZG5UM013VW5VMFkzWkxVSGhJTlV0M2VITndZbXBpUmt4NlprWjNURXBNY0ZGeU5GTnFZakJRVDJ0aU9WaDRTM1YyTnpWRVdHOVFialJhUW1VNVJXVkVWSGRFY0cxYWRXSnZiMkZPYTBaRkswOVpSbm8yVG1WcFFXbDJXa0Z1VXpKSVZHVm9ObmRwZFM4elpuUkhla0UwYjBJMWNVVTFWWEkyZGtKMVpFczJVMjVNT0ZKQldHTk5kVGgzU0RKSFpuRmtVV1Z2UXpGbE4zQldRMkZNWlZneVpXWnJVblkxWnprM1dteG9OSFJ0TUVsdVdtSkpkSHBFVUZVMlkwNVdNVzgwY0drd2NraFpNVEl4WkVONmMzaHNWVmhCWlUxWE4zYzRWRTlFYmpCa09EQjNjMU5oV0dGb1VDOVplWHBXVkdFclZHbEdZVzg1ZWk5cGRETldUM051V1M5clZFbDVVME0yVlZaUWFqWlBSMEpKWWprNWJGSmphVVUwYkM5d0szaHBiSHBrY0Nzd2NXUmtMeXQyTVVGdlRWaHVTMmRUVEdsUWJFTjFlR1V6VUcxVGFsZE9WVkZaWkV4eFEwaFFPVzlTV2tWRVZrMHZSV1pUTldzNE0zTmtkRWRPUlZsV2RsZzJkRzVNYW1OaFptSjVVMFJFZW05b04wbEpRbWR3SzI5alNEbEZWMUJsUmxFNFVtbEpWV2RLVFRCc1lqTXliMmt5VjBodmVtUnNOM1ozZEhOd2RtTkdTR1JGUjNKblZUWldlbkJ2UTBaa0wwRnFUVXB5VnpCcGFUaFVObTU0UnpSTFdrOTJkbmRLSzFKNmREZDFSalpOVTIxTE5rTXZRMkp5YVhKSFVXTlhNRTF2YWpWcWJWWllhbGxNYkhoTlVqVnRXVmhIYzJoVlZucE1UMDFUVkVaNFRsWjBZelF2Y3pBM1FtMTFaVEJOVWxadU5FSXJhRlF6TWs1cWVIVlhaamxFU1dkU1JFcFZkRlpsVlU1MVUxSjRlVTkxU2tad05VMXdlSE53YlVNNWNqTnhiRlJ0VFdKcFduUnBXbk00U2todWNYSjFabkZaZGs1bFFuZG9lSE5KZWt0VkszUkVVVDA5SW4wc0luSmxjWFZsYzNSbFpFRjBkSEpwWW5WMFpYTWlPbnNpYzNOdUlqcDdJbk56YmlJNklqRTVOelV3TVRJNU56ZzFNaUlzSW1OdmRXNTBjbmtpT2lKVFJTSjlmU3dpZFhObGNrbHVabTlVZVhCbElqb2lVMU5PSWl3aWRYTmxja2x1Wm04aU9pSjdYQ0p6YzI1Y0lqcGNJakU1TnpVd01USTVOemcxTWx3aUxGd2lZWRBdHRyaWJ1dGMjkxYm5SeWVWd2lPbHdpVTBWY0luMGlmUS5RTWlIenpwZS1nRzBHbmlDSjVkVHA2QTFURElmVENSaXlTSm8wWi1JMGg3bDhIZHo5UldIdjJoOTNPTmNMLXRZZ0Y3X0E1NWFJamY0NDdRR3pXb0FaRzRaTUIzSUpVLUltdWJSVU1FaUZUWTcyVmlNZWwyTE80bm83eW1sZ3FFQURtU0llTXBHWRBdHRyaWJ1dGVEZhMzhYZkJYWUVhZlFPVU45WlhyeWhkMlc2WWYwWk9yNjBmTmp4UVZqb3pKUzVxak1ZeThGLTh2UzltMlNzaDkycFNvYWJvN21wRE5yMUNBYkQ2WTgyMTJyLUFzLVJFUktvVWxXLXZZdTlUOURmeDkxSGk2TGdQT2V1SVJhS2pTN3JhQU1qeVZ3ZWxOZVF2LThxRGlzWGtUY2hfYXJGQTRfRmtpSDNPNDJJb0hCNVdRM0psMmJyWnl5aGk3ZDVmMzBfRXN3bG9vX0NUNWciLAogICJyZXF1ZXN0ZWRBWRBdHRyaWJ1dGWRBdHRyaWJ1dGdHRyaWJ1dGVzIiA6IHsKICAgICJzc24iIDogewogICAgICAic3NuIiA6ICIxOTc1MDEyOWRBdHRyaWJ1dGTc4NTIiLAogHVNa0pvVFICAgICAiY291bnRyeSIgOiAiU0UiCiAgICB9CiAgfSwKICAic2lnblJlZiIgOiAiNmF4MzgwSHRaX1NtRlotNlRqZEh1ckJkekxTY1d0bW9lWXQtaFY5dFRDR3dYSU5pUFRsTGZaZUMybWRBdHRyaWJ1dG3lnMkwzRiIKfQ==WRBdHRyaWJ1dG",
  "sn": "",
  "signRef": "6aert3380HtZ_SmFZ-6TjdHurBdzLScWtmoeYt-hV9tTCGwXINiPTlLfZeC2oyg2L3F",
  "status": "APPROVED",
  "ssn": "1912121212"
}

Common errors

Common errors will result in a HTTP Status 500 with a body containing the error message:

{”message”:”<error explained>”}