Collect
As an alternative to receiving a callback from IDkollen on successful or failed requests,
you can use the /collect
endpoint to check the status of a request. \
NOTE: Rate limit for polling this endpoint is once per second.
GET https://api.idkollen.se/v2/{api-key}/collect/{orderRef}
IDkollen will respond with HTTP status 200 for successful request, or 4xx/5xx on errors. For more information about errors, please see the Errors section.
The value of result
is either progress
, completed
or failed
.
Additional info will be found in the hintCode
property.
HTTP/2.0 200 OK
{
"status": "progress",
"orderRef": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
"hintCode": "outstandingTransaction"
}
HTTP/2.0 200 OK
{
"status": "completed",
"orderRef": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
"pno": "191234567890",
"name": "Firstname Lastname",
"givenName": "Firstname",
"surname": "Lastname"
}
HTTP/2.0 200 OK
{
"status": "failed",
"orderRef": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
"hintCode": "expiredTransaction"
}
For information about the hintCode
values, please refer to the BankID Relying Party Guidelines.