API docs by Redocly

Digital Identity Service API (1.52.0)

Download OpenAPI specification:Download

Actuator

Get application info

Responses

Response samples

Content type
application/json
{
  • "build": {
    },
  • "iface": {
    },
  • "sam": {
    }
}

Get application health

Responses

Response samples

Content type
application/json
{
  • "status": "UP"
}

Customer onboarding

Get customer's selfie image

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Provide customer's selfie

Authorizations:
api
path Parameters
id
required
string
Request Body schema:
required
object (Image)

Image provided as Base64 encoded string or via URL. Data or URL have to be provided.

object (LivenessSelfieOrigin)

This allows to link the image from liveness to be selfie photo. Do not upload the photo in Image class in this case.

Responses

Request samples

Content type
{
  • "image": {},
  • "selfieOrigin": {
    }
}

Response samples

Content type
application/json
{
  • "detection": {
    },
  • "links": {
    },
  • "errorCode": "NO_FACE_DETECTED",
  • "warnings": [
    ],
  • "additionalData": {
    }
}

Delete customer's selfie

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": "NOT_FOUND",
  • "errorMessage": "string"
}

Create customer's liveness

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "links": {
    }
}

Delete customer's liveness

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": "NOT_FOUND",
  • "errorMessage": "string"
}

Create customer's liveness record challenge

Authorizations:
api
path Parameters
id
required
string
Request Body schema: application/json
required
type
required
string
Enum: "EYE_GAZE_LIVENESS" "PASSIVE_LIVENESS" "SMILE_LIVENESS" "MAGNIFEYE_LIVENESS"

Liveness type for the challenge.

Responses

Request samples

Content type
application/json
{
  • "type": "EYE_GAZE_LIVENESS"
}

Response samples

Content type
application/json
{
  • "details": {
    }
}

Create customer's document

Authorizations:
api
path Parameters
id
required
string
Request Body schema: application/json
required
object (DocumentAdvice)

Advice to the OCR document classification process about expected document type in the uploaded image.

sources
Array of strings
Items Enum: "VIZ" "MRZ" "BARCODE" "DOCUMENT_PORTRAIT" "GLOBAL_OCR"

The document sources. The chosen document sources indicate which part of the document should be processed. For instance, if only MRZ is requested, the document is classified only by MRZ, and only MRZ is recognized and processed.

Responses

Request samples

Content type
application/json
{
  • "advice": {
    },
  • "sources": [
    ]
}

Response samples

Content type
application/json
{
  • "links": {
    }
}

Delete customer's document

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": "NOT_FOUND",
  • "errorMessage": "string"
}

Provide customer's document page

Authorizations:
api
path Parameters
id
required
string
Request Body schema:
required
required
object (Image)

Image provided as Base64 encoded string or via URL. Data or URL have to be provided.

object (DocumentPageAdvice)

The document page processing advice.

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "documentType": {
    },
  • "pageType": "front",
  • "detection": {
    },
  • "errorCode": "NO_CARD_CORNERS_DETECTED",
  • "warnings": [
    ],
  • "links": {
    },
  • "additionalData": {
    }
}

Get customer's document chip raw data

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Create customer's document chip data

Authorizations:
api
path Parameters
id
required
string
Request Body schema: application/octet-stream
required
string <byte>

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "errorCode": "LDS_PARSE_ERROR"
}

Create customer's challengeBytes for document chip

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "challenge": "string"
}

Create a customer

Authorizations:
api

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    }
}

Get the customer

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "customer": {
    }
}

Create a customer with a custom UUIDv4

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    }
}

Delete the customer

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": "NOT_FOUND",
  • "errorMessage": "string"
}

Provide customer's liveness selfie

Authorizations:
api
path Parameters
id
required
string
Request Body schema: application/json
required
object (Image)

Image provided as Base64 encoded string or via URL. Data or URL have to be provided.

object (SelfieOrigin)

This allows to link the image already used for customer selfie to be reused as one of the liveness photos, ideal for using the selfie photo for passive liveness. Do not upload the photo in Image class in this case.

assertion
required
string
Enum: "EYE_GAZE_TOP_LEFT" "EYE_GAZE_TOP_RIGHT" "EYE_GAZE_BOTTOM_LEFT" "EYE_GAZE_BOTTOM_RIGHT" "SMILE" "NEUTRAL" "NONE"

Definition of the active liveness challenge that the customer's face has to display in the provided selfie photo. E.g. if it is expected that the face is looking to top left corner of the screen, assertion EYE_GAZE_TOP_LEFT has to be used.

Responses

Request samples

Content type
application/json
{
  • "image": {},
  • "selfieOrigin": {
    },
  • "assertion": "EYE_GAZE_TOP_LEFT"
}

Response samples

Content type
application/json
{
  • "errorCode": "NO_FACE_DETECTED",
  • "warnings": [
    ]
}

Retrieves customer's liveness selfies and liveness record selfies of given LivenessType

Authorizations:
api
path Parameters
id
required
string
Request Body schema: application/json
required
type
required
string
Enum: "EYE_GAZE_LIVENESS" "PASSIVE_LIVENESS" "SMILE_LIVENESS" "MAGNIFEYE_LIVENESS"

Describes which type of liveness selfies and record liveness selfies should be returned

Responses

Request samples

Content type
application/json
{
  • "type": "EYE_GAZE_LIVENESS"
}

Response samples

Content type
application/json
{
  • "selfies": [
    ],
  • "recordSelfies": [
    ]
}

Provide customer's liveness record

Authorizations:
api
path Parameters
id
required
string
Request Body schema: application/octet-stream
required
string <byte>

Responses

Response samples

Content type
application/json
{
  • "selfie": {
    },
  • "links": {
    },
  • "errorCode": "INVALID_DATA",
  • "additionalData": {
    }
}

Evaluate customer's liveness

Authorizations:
api
path Parameters
id
required
string
Request Body schema: application/json
required
type
required
string
Enum: "EYE_GAZE_LIVENESS" "PASSIVE_LIVENESS" "SMILE_LIVENESS" "MAGNIFEYE_LIVENESS"

Responses

Request samples

Content type
application/json
{
  • "type": "EYE_GAZE_LIVENESS"
}

Response samples

Content type
application/json
{
  • "score": 0.8,
  • "errorCode": "INVALID_DATA"
}

Inspect customer

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "selfieInspection": {
    },
  • "security": {
    },
  • "links": {
    }
}

Disclose customer inspection

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "selfieInspection": {
    }
}

Inspect customer's document

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "expired": false,
  • "mrzInspection": {
    },
  • "portraitInspection": {
    },
  • "visualZoneInspection": {
    },
  • "pageTampering": {
    },
  • "chipInspection": {
    }
}

Disclose customer's document inspection

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "pageTampering": {
    }
}

Get customer's liveness record's selfie

Authorizations:
api
path Parameters
id
required
string
recordId
required
string
query Parameters
width
integer <int32>
height
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Get customer's document signature

Authorizations:
api
path Parameters
id
required
string
query Parameters
width
integer <int32>
height
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Get customer's document portrait

Authorizations:
api
path Parameters
id
required
string
query Parameters
width
integer <int32>
height
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Get normalized image of the customer's document page

Authorizations:
api
path Parameters
id
required
string
page-type
required
string
query Parameters
width
integer <int32>
height
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Check quality of the customer's document page

Authorizations:
api
path Parameters
id
required
string
page-type
required
string

Responses

Response samples

Content type
application/json
{
  • "fine": false,
  • "issues": "BRIGHTNESS_HIGH",
  • "warnings": "DOCUMENT_CLOSE_TO_IMAGE_BORDER",
  • "details": {
    }
}

Get customer's document ghost portrait

Authorizations:
api
path Parameters
id
required
string
query Parameters
width
integer <int32>
height
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Get customer's fingerprint from the document

Authorizations:
api
path Parameters
id
required
string
query Parameters
width
integer <int32>
height
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Get customer's document chip portrait

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Session management

Create a session

Authorizations:
api
Request Body schema: application/json
required
timeout
required
integer <int32>

The session's timeout in seconds.

Responses

Request samples

Content type
application/json
{
  • "timeout": 600
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Close the session

Authorizations:
api
header Parameters
x-inn-session-token
required
string

Session token as Base64 text

Responses

Response samples

Content type
application/json
{
  • "errorCode": "NOT_FOUND",
  • "errorMessage": "string"
}

Palm operations

Create a palm from the photo

Authorizations:
api
Request Body schema:
required
required
object (Base64ImageDto)

Image provided as Base64 encoded string.

Responses

Request samples

Content type
{
  • "image": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "detection": {
    },
  • "links": {
    },
  • "errorCode": "NO_PALM_DETECTED"
}

Match the probe palm to the reference palm

Authorizations:
api
path Parameters
probe_palm_id
required
string
Request Body schema: application/json
required
referencePalm
string

The reference palm

referencePalmTemplate
string <byte>

Responses

Request samples

Content type
application/json
{
  • "referencePalm": "/api/v1/palms/ff0d8fb4-be47-4858-b03c-6f21b479c302",
  • "referencePalmTemplate": "string"
}

Response samples

Content type
application/json
{
  • "score": 0.83,
  • "errorCode": "PALM_TEMPLATE_VERSION_MISMATCH"
}

Inspect palm

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "securityInspection": {
    }
}

Get the palm's template

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "version": "1.13"
}

Delete the palm

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": "NOT_FOUND",
  • "errorMessage": "string"
}

Face operations

Create a face from the photo (face detection)

Authorizations:
api
Request Body schema:
required
object (Image)

Image provided as Base64 encoded string or via URL. Data or URL have to be provided.

object (FaceDetectionProperties)

The face detection properties

object (CustomerSelfieOrigin)

This allows to link the image from customer selfie or face from the document portrait. Do not upload the photo in Image class in this case and do not set detection properties.

Responses

Request samples

Content type
{
  • "image": {},
  • "detection": {
    },
  • "faceOrigin": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "detection": {
    },
  • "links": {
    },
  • "errorCode": "MULTIPLE_FACES_DETECTED",
  • "warnings": [
    ]
}

Match the probe face to the reference face

Authorizations:
api
path Parameters
probe_face_id
required
string
Request Body schema: application/json
required
referenceFace
string

The reference face

referenceFaceTemplate
string <byte>

Responses

Request samples

Content type
application/json
{
  • "referenceFace": "/api/v1/faces/ff0d8fb4-be47-4858-b03c-6f21b479c302",
  • "referenceFaceTemplate": "string"
}

Response samples

Content type
application/json
{
  • "score": 0.83
}

Get the face's quality

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "sharpness": {
    },
  • "brightness": {
    },
  • "contrast": {
    },
  • "uniqueIntensityLevels": {
    },
  • "shadow": {
    },
  • "noseShadow": {
    },
  • "specularity": {
    },
  • "backgroundUniformity": {
    },
  • "redRightEye": {
    },
  • "redLeftEye": {
    },
  • "roll": {
    },
  • "yaw": {
    },
  • "pitch": {
    },
  • "eyeDistance": {
    },
  • "eyeGaze": {
    },
  • "rightEye": {
    },
  • "leftEye": {
    },
  • "mouth": {
    },
  • "faceSize": {
    },
  • "faceRelativeArea": {
    },
  • "faceRelativeAreaInImage": {
    }
}

Check if glasses are present on the face

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "score": 0.83,
  • "tinted": 0.83,
  • "heavyFrame": 0.83
}

Get the face's template

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "version": "1.13"
}

Check if the face is covered by a mask

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "score": 0.83
}

Get the face's crop

Authorizations:
api
path Parameters
id
required
string
query Parameters
width
integer <int32>
height
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Get the face's crop with removed background

Authorizations:
api
path Parameters
id
required
string
query Parameters
width
integer <int32>
height
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Get face's crop coordinates

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "fullyCaptured": true,
  • "coordinates": {
    }
}

Get face's aspects

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "age": 24,
  • "gender": 0.5
}

Delete the face

Authorizations:
api
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": "NOT_FOUND",
  • "errorMessage": "string"
}

Trust Platform

Store customer in the Trust Platform

Authorizations:
api
path Parameters
id
required
string
Request Body schema: application/json
required
externalId
string^[a-zA-Z\d._-]{1,64}$

External identifier of the customer (for pairing between Trust Platform and external database), limited to alphanumeric, '.', '-' and '_' characters and maximum length of 64. If not supplied, the UUID of the customer present in the request URL is used instead.

onboardingStatus
required
string
Enum: "IN_PROGRESS" "FINISHED"

Onboarding status of the customer to be stored in the Trust Platform. Use the FINISHED status only if you have collected all required data of the customer.

Responses

Request samples

Content type
application/json
{
  • "externalId": "55bd71d3-12cc-4c15-accd-b6dc8702bf3b",
  • "onboardingStatus": "IN_PROGRESS"
}

Response samples

Content type
application/json
{
  • "errorCode": "NOT_FOUND",
  • "errorMessage": "string"
}

Metadata

Get metadata

Authorizations:
api

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ]
}