Document toolboxDocument toolbox

Header

02 Get the basis check

Owned by Andrei Galitski
Last updated: Apr 08, 2021 by Bernd Hochmuth
1 min read
URL

/api/v1/checks/{checkId}

HTTP MethodGET
Short descriptionReturns current status of the check with all relevant data.
Request
NameTypeMandatoryDescription

check-id

stringYES

Check-ID generated by GiroIdent. See 01 Create a new basis check.

Errors
CauseHTTP Code
Bad request.
Raised while resolving a controller method argument.
Thrown when binding errors are considered fatal.
Exception to be thrown when validation on an argument fails.		400
Authentication object has invalid authentication reasons.
Thrown by the security manager to indicate a security violation.		401
Forbidden403
Thrown when can not find entity by request parameters or identifiers.404
An unexpected error occurred. Different finapi errors in responses.500

Description

Returns current status of the check with all relevant data.

Request sample

https://giroident.finapi.io/api/v1/checks/ed327f56-efd9-4ac4-b0fc-0a23b507c485

Response

AttributeTypeDescription
check-id
stringUUID for the check. Generated by GiroIdent
first-name
stringUser's first name. (Provided at 01 Create a new basis check)
last-name
stringUser's last name. (Provided at 01 Create a new basis check)
cancel-url
stringCancel URL.   (Provided at 01 Create a new basis check)
result-url
stringResult URL.  (Provided at 01 Create a new basis check)
iban
stringUser's IBAN. (Provided at 01 Create a new basis check) 
bank-id
stringBank id of the user. (Provided at 01 Create a new basis check)
blz
stringBank BLZ of the user. (Provided at 01 Create a new basis check)
name-equality
integer

"normalized" equality score. Takes either of two values 1 or 0.

name-equality-score,
number

Equality score for the best matching account holder name and first and last name provided.

from (including) 0 to 1.

0 - being "no similarity at all"

1 - being completely equal.

status
enum

Status of the check:

REGISTRATION, CREDENTIALS, UPDATE_REQUIRED, COMPLETED

external-id

string

optional

Client app specific id to be stored with the check if provided
Response
{
  "check-id": "string",
  "first-name": "string",
  "last-name": "string",
  "cancel-url": "string",
  "result-url": "string",
  "iban": "string",
  "bank-id": "string",
  "blz": "string",
  "name-equality": 0,
  "name-equality-score": 0.7,
  "status": "REGISTRATION"
}

Footer