Collect

The GET /v3/bankid-no/auth/{{id}} endpoint is used to check the status of an auth request, and GET /v3/bankid-no/sign/{{id}}for a sign request.

NOTE: This endpoint is rate limited to one request per second.

GET /v3/bankid-no/auth/{{id}}
Authorization: Basic ${ base64(accountId + ':' + secretKey) }

GET /v3/bankid-no/sign/{{id}}
Authorization: Basic ${ base64(accountId + ':' + secretKey) }

This endpoint will respond with a HTTP status of 404 if the authentication session has expired.

The status of an authentication can be either one of: PENDING, COMPLETED or FAILED.

Pending

{
  "id": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
  "refId": "12398698",
  "status": "PENDING"
}

Parameter	Description
refId	The refId given in the request, if any.

Completed

{
  "id": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
  "refId": "12398698",
  "status": "COMPLETED",
  "ssn": "YYYYMMDDXXXX",
  "name": "Firstname Lastname",
  "givenName": "Firstname",
  "surname": "Lastname",
  "birthDate": "1908-09-29",
  "signResult": {
    "endUser": "MIAGC...",
    "merchant": "MIAGC...",
    "hash": "4oK3g..."
  }
}

Parameter	Description
refId	The refId given in the request, if any.
ssn	A Norwegian personal identification number to be used to complete the transaction. May be null if requestSsn was unset.
name	The full name of the authenticated user.
givenName	The given name of the authenticated user.
surname	The surname of the authenticated user.
birthDate	The birth date of the authenticated user.
signResult	Present for signs, containing signatures of the merchant and end user, as well as the hash of the signed text.

Failed

{
  "id": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
  "refId": "12398698",
  "status": "FAILED",
  "error":  "INVALID_ID"
}

Parameter	Description
refId	The refId given in the request, if any.
error	An error code describing the reason for why the authentication failed.

The error may be one of the following values:

Code	Description
AUTH_FAILED	A generic code for any kind of failure.
CANCELLED	The authentication was cancelled either by the user or the partner.
INVALID_ID	The ID has expired or is otherwise invalid.
INTERNAL_ERROR	An internal error occurred causing the authentication to fail.
SESSION_TIMEOUT	The authentication expired or timed out.
UNSUPPORTED_CLIENT	The client used for the authentication is not supported.

New error codes may be added in the future without prior notice. The partner should therefore handle unknown error codes in their implementations.