eKYC gateway API (1.1.0)

Download OpenAPI specification:Download

Face matching

Match file over the generated template

query Parameters
encrypted
required
boolean

set to true if payload is encrypted and false if unencrypted

Request Body schema: multipart/form-data
file
required
string <binary>

payload

template
required
string <string>

base64 encoded template

Responses

Response samples

Content type
application/json
{
  • "probability": 0.1,
  • "error": "string",
  • "status_code": "OK | ERROR"
}

Generate matching template from file

query Parameters
encrypted
required
boolean

should be set to true if payload is encrypted and false if unencrypted

Request Body schema: application/octet-stream
required
string <binary>

payload

Responses

Response samples

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

Create new collection

query Parameters
collection
required
string

collection name

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "Exception message"
}

Remove collection

query Parameters
collection
required
string

collection name

force
boolean

remove any collection

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "Exception message"
}

Add templates to the database

query Parameters
collection
required
string

target database collection. If collection does not exist, an error will be thrown

Request Body schema: application/json
required
templates
Array of strings

Responses

Request samples

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

Response samples

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

Generate templates from image and add it to the database

query Parameters
collection
required
string

target database collection. If collection does not exist, an error will be thrown

maxFaces
integer <int32>
Default: 1

maximum number of faces on the image

encrypted
required
boolean

set to true if payload is encrypted and false if unencrypted

Request Body schema: application/octet-stream
required
string <binary>

payload

Responses

Response samples

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

Remove record from collection

query Parameters
collection
required
string

collection name

recordId
required
string

record id

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "Exception message"
}

Decryption

Decrypt encrypted payload

Request Body schema: application/octet-stream
required
file <binary>

encrypted payload

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "Failed to parse file"
}

eKYC checks

Invoke eKYC checks

query Parameters
encrypted
boolean
Default: true

should be set to true if payload is encrypted and false if unencrypted

Request Body schema: multipart/form-data
required
object (EKycCheckModel)
face
string <binary>

face payload

doc
string <binary>

document payload

Responses

Response samples

Content type
application/json
{
  • "face_result": {
    },
  • "doc_result": {
    },
  • "face_validation_result": {
    },
  • "face_search_result": {
    }
}