get https://example.com/authentication/session/
The Get Authentication Session Status command returns the current status of an authentication session.
The providers may have a rate limit on how often you are allowed to check an authentication sessions status, if you poll this endpoint at a higher rate than this limit you will get an error message telling you to back off and poll with a higher interval.
GET /authentication/session/{sessionId}
Request Parameters
| Property | Type | Description |
|---|---|---|
sessionIdrequired | guid | The ID of the authentication session. Examples: "eb85023a-ff9d-4537-95d0-f9d045b3e872" |
Response Parameters
| Property | Type | Description |
|---|---|---|
statusCodeconditional | string | The normalized status code for the authentication sessions current status. Possible values: > "Initiated", "Ongoing", "Completed", "Failed", "Expired", "Cancelled" |
providerStatusCodeconditional | string | The verbatim status code returned by the authentication provider. Possible values: > Please refer to the authentication providers documentation for a listing of the possible status codes. |
providerErrorCode | string | The verbatim status code returned by the authentication provider. Possible values: > Please refer to the authentication providers documentation for a listing of the possible status codes. |
statusrequired | status | API Operation status. |
qrImage | string | Base64 encoded QR code image that shall be shown to consumer when initiating authentication session on another device. The QR code shall be updated every second because the current QR code is only valid for a couple of seconds. |
governmentId | string | The government ID of authenticated person that will be returned when session has completed status. |
qrData | string | QR code data that can be used to create the QR code image instead of using provided encoded image in the property qrImage. |