API Documentation - 6.0

Authenticate

Initiate an auth request.

POST: /api/v6.0/auth
PARAMETERS
personal_number null | string (12 digits)
user_visible_data null | string (markdown)

user_invisible_data null | string

RESPONSE OBJECT 
{
    orderRef: string (UUID),
    autoStartToken: string (UUID),
}

Sign

Initiate a sign request.

POST: /api/v6.0/sign
PARAMETERS
personal_number null | string (12 digits)
user_visible_data null | string (markdown)

user_invisible_data null | string

RESPONSE OBJECT 
{
    orderRef: string (UUID),
    autoStartToken: string (UUID),
}

QR

GET: /api/v6.0/qr/{orderRef}

Get the collect object containing current auth or sign status.

PARAMETERS
qr_size integer

Default: 300

qr_format string

Default: png. Allowed: svg, png

RESPONSE
Base64-encoded image

Collect

GET: /api/v6.0/collect/{orderRef}

Get the collect object containing current auth or sign status.

PARAMETERS
with_qr boolean

Default: false

RESPONSE 
{
    hintCode: string,
    message: string,
    qrSrc: ?string,
    orderRef: string (UUID),
    status: string
}