Skip to main content
API docs by Redocly

KYC API (2.10.15)

Download OpenAPI specification:Download

KYC API

Utility

Root endpoint

Returns service information and documentation links.

Responses

Response samples

Content type
application/json
{
  • "service": "string",
  • "description": "string",
  • "version": "string",
  • "environment": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "documentation": "string",
  • "health": "string",
  • "status": "string"
}

Ping

Basic connectivity test.

Responses

Response samples

Content type
application/json
{
  • "pong": true,
  • "timestamp": "2019-08-24T14:15:22Z"
}

API status

Returns API status and available endpoints.

Responses

Response samples

Content type
application/json
{
  • "service": "string",
  • "version": "string",
  • "environment": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "uptime": 0,
  • "endpoints": {
    }
}

System metrics

Returns system and environment metrics.

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "system": {
    },
  • "environment": {
    }
}

Liveness probe

Checks if the service is alive.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "uptime": 0
}

Readiness probe

Checks if the service is ready to receive traffic.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "checks": {
    }
}

Simple health check

Returns a simple health status for load balancers.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Health check

Returns health status of the service and dependencies.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "uptime": 0,
  • "version": "string",
  • "environment": "string",
  • "checks": {
    },
  • "details": {
    },
  • "error": "string"
}

Get API version

Returns the current version of the API.

Responses

Response samples

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

IDV SDK

sdk metadata update

SDK metadata update.

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "sdk_metadata": {
    }
}

Response samples

Content type
application/json
{ }

sdk liveness session generate

SDK access to generate a liveness session

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string
latitude
required
number
longitude
required
number

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

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

sdk liveness session process

SDK access to process a liveness session

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string
latitude
required
number
longitude
required
number
images
Array of strings

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "images": [
    ]
}

Response samples

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

sdk session read

SDK access to read the session information

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "session_id": "string",
  • "client_id": "string",
  • "document_type_e": "string",
  • "consented": true,
  • "document_front_given": true,
  • "document_back_given": true,
  • "liveness_detected": true,
  • "selfie_given": true,
  • "liveness_provider_e": "azure",
  • "sdk_metadata": {
    },
  • "settings": {
    }
}

sdk add identity consent

Add identity consent. This must be done after session. All other endpoints will fail if this is not added to the system.

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string
consented
required
boolean

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "consented": true
}

Response samples

Content type
application/json
{ }

sdk document type update

SDK document type update.

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string
document_type_e
required
string
Enum: "unknown" "driver_license" "identification_card" "passport" "passport_card"

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "document_type_e": "unknown"
}

Response samples

Content type
application/json
{ }

sdk document front image add

SDK document front image add.

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: multipart/form-data
session_id
required
string
latitude
required
string non-empty
longitude
required
string non-empty
image
string <binary>

Responses

Response samples

Content type
application/json
{ }

sdk document back image add

SDK document back image add.

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: multipart/form-data
session_id
required
string
latitude
required
string non-empty
longitude
required
string non-empty
image
string <binary>

Responses

Response samples

Content type
application/json
{ }

sdk idv finalization

Finalizes the identity verification process for the SDK.

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string
object

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "verified": true,
  • "on_sanction_list": true
}

IDV

idv session location read response

IDV Session Location read response

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string
location_capture_type_e
required
string
Enum: "unknown" "front_doc_image_capture" "back_doc_image_capture" "selfie_image_capture"

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "location_capture_type_e": "unknown"
}

Response samples

Content type
application/json
{
  • "ip_address": "string",
  • "ip_latitude": 0,
  • "ip_longitude": 0,
  • "ip_country": "string",
  • "ip_region": "string",
  • "ip_city": "string",
  • "device_location": "string",
  • "device_latitude": 0,
  • "device_longitude": 0,
  • "device_country_name": "string",
  • "device_country_code": "string",
  • "device_admin_area": "string",
  • "device_sub_admin_area": "string",
  • "device_locality": "string"
}

session anonymize

Session anonymize for identity verification.

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{ }

session delete

Session delete for identity verification.

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{ }

session create

Session create for identity verification.

Authorizations:
oauth2
Request Body schema: application/json
object
liveness_mode
string
Enum: "passive" "passive_active"
webhook_url
string
object

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "liveness_mode": "passive",
  • "webhook_url": "string",
  • "settings": {
    }
}

Response samples

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

session list

Session list for identity verification.

Authorizations:
oauth2
Request Body schema: application/json
take
number
skip
number
search_term
string
start_date
string or null
end_date
string or null
object
string or Array of strings
status
string
Enum: "unknown" "in_progress" "complete" "temporarily_blocked" "temporarily_complete" "expired"
string or Array of strings
string or Array of strings

Responses

Request samples

Content type
application/json
{
  • "take": 0,
  • "skip": 0,
  • "search_term": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "metadata": {
    },
  • "identity_id": "string",
  • "status": "unknown",
  • "client_id": "string",
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "sessions": [
    ],
  • "meta_counts": {
    }
}

session read

Session read for identity verification.

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "session_id": "string",
  • "user_id": "string",
  • "client_id": "string",
  • "idv_weights_id": "string",
  • "status_e": "unknown",
  • "document_type_e": "unknown",
  • "created_at": "string",
  • "completed_at": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "suffix_name": "string",
  • "gender_e": "unknown",
  • "birth_date": "string",
  • "consented": true,
  • "consented_at": "string",
  • "document_front_given": true,
  • "document_front_given_at": "string",
  • "document_back_given": true,
  • "document_back_given_at": "string",
  • "liveness_detected": true,
  • "liveness_detected_at": "string",
  • "selfie_given": true,
  • "selfie_given_at": "string",
  • "dmv_status_e": "unknown",
  • "dmv_detected_at": "string",
  • "ofac_status_e": "unknown",
  • "ofac_detected_at": "string",
  • "verified": true,
  • "verified_at": "string",
  • "score": 0,
  • "identity_id": "string",
  • "metadata": {
    },
  • "webhook_url": "string",
  • "settings": {
    },
  • "history": [
    ]
}

document read

Document read for identity verification.

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "session_id": "string",
  • "document_id": "string",
  • "type_e": "unknown",
  • "data_source_e": "unknown",
  • "document_number": "string",
  • "ref_number": "string",
  • "issued_at": "string",
  • "expires_at": "string",
  • "issuing_country": "string",
  • "issuing_state": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "name_suffix": "string",
  • "street": "string",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "birth_date": "string",
  • "gender_e": "unknown",
  • "height": "string",
  • "weight": "string",
  • "eye_color": "string",
  • "hair_color": "string",
  • "class": "string",
  • "restrictions": "string"
}

document list

Document list for identity verification.

Authorizations:
oauth2
Request Body schema: application/json
take
number
skip
number
session_id
required
string

Responses

Request samples

Content type
application/json
{
  • "take": 0,
  • "skip": 0,
  • "session_id": "string"
}

Response samples

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

document download

Document download for identity verification.

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string
storage_file_type_e
required
string
Enum: "unknown" "driver_license_front" "driver_license_back" "state_id_card_front" "state_id_card_back" "passport_front" "passport_card_front" "passport_card_back" "selfie" "liveness_passive" "liveness_active_step_1" "liveness_active_step_2" "liveness_active_step_3" "liveness_active_step_4"

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "storage_file_type_e": "unknown"
}

Response samples

Content type
application/json
null

session test read

Session test read for identity verification.

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "doc_front_image_manipulation": "string",
  • "doc_front_is_identity_document": "string",
  • "doc_front_online_duplication": "string",
  • "doc_front_suspicious_words": "string",
  • "doc_back_image_manipulation": "string",
  • "doc_back_is_identity_document": "string",
  • "doc_back_online_duplication": "string",
  • "doc_back_suspicious_words": "string",
  • "dmv_document_number_match": true,
  • "dmv_document_expiration_match": true,
  • "dmv_document_issue_match": true,
  • "dmv_document_category_match": true,
  • "dmv_birth_date_match": true,
  • "dmv_sex_match": true,
  • "dmv_eye_color_match": true,
  • "dmv_height_match": true,
  • "dmv_weight_match": true,
  • "dmv_first_name_match": true,
  • "dmv_middle_name_match": true,
  • "dmv_last_name_match": true,
  • "dmv_suffix_name_match": true,
  • "dmv_street_match": true,
  • "dmv_city_match": true,
  • "dmv_state_match": true,
  • "dmv_postal_code_match": true,
  • "document_number_crosscheck": true,
  • "name_crosscheck": true,
  • "address_crosscheck": true
}

get requirements

Get the requirements for the given type and data source.

Authorizations:
oauth2
query Parameters
client_id
string
user_id
string
type_e
string
Enum: "unknown" "driver_license" "identification_card" "passport" "passport_card"
data_source_e
string

Responses

Response samples

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

update requirements

Update the requirements for the given type and data source.

Authorizations:
oauth2
Request Body schema: application/json
client_id
string
user_id
string
type_e
required
string
Enum: "unknown" "driver_license" "identification_card" "passport" "passport_card"
data_source_e
required
string
document_number_required
required
boolean
ref_number_required
required
boolean
issue_at_required
required
boolean
expires_at_required
required
boolean
issuing_country_required
required
boolean
issuing_state_required
required
boolean
first_name_required
required
boolean
middle_name_required
required
boolean
last_name_required
required
boolean
name_suffix_required
required
boolean
street_required
required
boolean
city_required
required
boolean
state_required
required
boolean
postal_code_required
required
boolean
birth_date_required
required
boolean
gender_required
required
boolean
height_required
required
boolean
weight_required
required
boolean
eye_color_required
required
boolean
hair_color_required
required
boolean
class_required
required
boolean
mentions_required
required
boolean
restrictions_required
required
boolean
raw_barcode_required
required
boolean
face_encoding_required
required
boolean

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "user_id": "string",
  • "type_e": "unknown",
  • "data_source_e": "string",
  • "document_number_required": true,
  • "ref_number_required": true,
  • "issue_at_required": true,
  • "expires_at_required": true,
  • "issuing_country_required": true,
  • "issuing_state_required": true,
  • "first_name_required": true,
  • "middle_name_required": true,
  • "last_name_required": true,
  • "name_suffix_required": true,
  • "street_required": true,
  • "city_required": true,
  • "state_required": true,
  • "postal_code_required": true,
  • "birth_date_required": true,
  • "gender_required": true,
  • "height_required": true,
  • "weight_required": true,
  • "eye_color_required": true,
  • "hair_color_required": true,
  • "class_required": true,
  • "mentions_required": true,
  • "restrictions_required": true,
  • "raw_barcode_required": true,
  • "face_encoding_required": true
}

Response samples

Content type
application/json
{ }

get weights

Get the weights for the IDV system.

Authorizations:
oauth2
query Parameters
client_id
string
user_id
string

Responses

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "user_id": "string",
  • "onboarding_face_encoding_tolerance": 0,
  • "verified_account_face_encoding_tolerance": 0,
  • "driver_license_fuzzy_match_tolerance": 0,
  • "driver_license_fuzzy_match_weight": 0,
  • "state_id_fuzzy_match_tolerance": 0,
  • "state_id_fuzzy_match_weight": 0,
  • "passport_fuzzy_match_tolerance": 0,
  • "passport_fuzzy_match_weight": 0,
  • "passport_card_fuzzy_match_tolerance": 0,
  • "passport_card_fuzzy_match_weight": 0,
  • "ofac_fuzzy_match_tolerance": 0,
  • "ofac_fuzzy_match_weight": 0,
  • "suspicious_words_weight": 0,
  • "image_manipulation_weight": 0,
  • "online_duplication_weight": 0,
  • "is_identity_document_weight": 0,
  • "aamva_match_tolerance": 0,
  • "aamva_match_weight": 0,
  • "idv_session_tolerance": 0,
  • "minimum_liveness_tolerance": 0,
  • "passive_active_skip_tolerance": 0,
  • "gender_probability_tolerance": 0,
  • "gender_weight": 0,
  • "expression_tolerance": 0,
  • "age_tolerance": 0,
  • "age_weight": 0,
  • "direction_tolerance": 0
}

update weights

Update the weights for the IDV system.

Authorizations:
oauth2
Request Body schema: application/json
client_id
string
user_id
string
onboarding_face_encoding_tolerance
required
number
verified_account_face_encoding_tolerance
required
number
driver_license_fuzzy_match_tolerance
required
number
driver_license_fuzzy_match_weight
required
number
state_id_fuzzy_match_tolerance
required
number
state_id_fuzzy_match_weight
required
number
passport_fuzzy_match_tolerance
required
number
passport_fuzzy_match_weight
required
number
passport_card_fuzzy_match_tolerance
required
number
passport_card_fuzzy_match_weight
required
number
ofac_fuzzy_match_tolerance
required
number
ofac_fuzzy_match_weight
required
number
suspicious_words_weight
required
number
image_manipulation_weight
required
number
online_duplication_weight
required
number
is_identity_document_weight
required
number
aamva_match_tolerance
required
number
aamva_match_weight
required
number
idv_session_tolerance
required
number
minimum_liveness_tolerance
required
number
passive_active_skip_tolerance
required
number
gender_probability_tolerance
required
number
gender_weight
required
number
expression_tolerance
required
number
age_tolerance
required
number
age_weight
required
number
direction_tolerance
required
number

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "user_id": "string",
  • "onboarding_face_encoding_tolerance": 0,
  • "verified_account_face_encoding_tolerance": 0,
  • "driver_license_fuzzy_match_tolerance": 0,
  • "driver_license_fuzzy_match_weight": 0,
  • "state_id_fuzzy_match_tolerance": 0,
  • "state_id_fuzzy_match_weight": 0,
  • "passport_fuzzy_match_tolerance": 0,
  • "passport_fuzzy_match_weight": 0,
  • "passport_card_fuzzy_match_tolerance": 0,
  • "passport_card_fuzzy_match_weight": 0,
  • "ofac_fuzzy_match_tolerance": 0,
  • "ofac_fuzzy_match_weight": 0,
  • "suspicious_words_weight": 0,
  • "image_manipulation_weight": 0,
  • "online_duplication_weight": 0,
  • "is_identity_document_weight": 0,
  • "aamva_match_tolerance": 0,
  • "aamva_match_weight": 0,
  • "idv_session_tolerance": 0,
  • "minimum_liveness_tolerance": 0,
  • "passive_active_skip_tolerance": 0,
  • "gender_probability_tolerance": 0,
  • "gender_weight": 0,
  • "expression_tolerance": 0,
  • "age_tolerance": 0,
  • "age_weight": 0,
  • "direction_tolerance": 0
}

Response samples

Content type
application/json
{ }

get weights by id

Get weights by ID for historical lookup.

Authorizations:
oauth2
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "user_id": "string",
  • "onboarding_face_encoding_tolerance": 0,
  • "verified_account_face_encoding_tolerance": 0,
  • "driver_license_fuzzy_match_tolerance": 0,
  • "driver_license_fuzzy_match_weight": 0,
  • "state_id_fuzzy_match_tolerance": 0,
  • "state_id_fuzzy_match_weight": 0,
  • "passport_fuzzy_match_tolerance": 0,
  • "passport_fuzzy_match_weight": 0,
  • "passport_card_fuzzy_match_tolerance": 0,
  • "passport_card_fuzzy_match_weight": 0,
  • "ofac_fuzzy_match_tolerance": 0,
  • "ofac_fuzzy_match_weight": 0,
  • "suspicious_words_weight": 0,
  • "image_manipulation_weight": 0,
  • "online_duplication_weight": 0,
  • "is_identity_document_weight": 0,
  • "aamva_match_tolerance": 0,
  • "aamva_match_weight": 0,
  • "idv_session_tolerance": 0,
  • "minimum_liveness_tolerance": 0,
  • "passive_active_skip_tolerance": 0,
  • "gender_probability_tolerance": 0,
  • "gender_weight": 0,
  • "expression_tolerance": 0,
  • "age_tolerance": 0,
  • "age_weight": 0,
  • "direction_tolerance": 0
}

IDA

ida session location read response

IDA Session Location read response

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string
location_capture_type_e
required
string
Enum: "unknown" "front_doc_image_capture" "back_doc_image_capture" "selfie_image_capture"

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "location_capture_type_e": "unknown"
}

Response samples

Content type
application/json
{
  • "ip_address": "string",
  • "ip_latitude": 0,
  • "ip_longitude": 0,
  • "ip_country": "string",
  • "ip_region": "string",
  • "ip_city": "string",
  • "device_location": "string",
  • "device_latitude": 0,
  • "device_longitude": 0,
  • "device_country_name": "string",
  • "device_country_code": "string",
  • "device_admin_area": "string",
  • "device_sub_admin_area": "string",
  • "device_locality": "string"
}

session delete

Session delete for identity authentication.

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{ }

identity authentication session create

Identity Authentication session create

Authorizations:
oauth2
Request Body schema: application/json
identity_id
required
string
webhook_url
string
liveness_mode
string
Enum: "passive" "passive_active"
object
object

Responses

Request samples

Content type
application/json
{
  • "identity_id": "string",
  • "webhook_url": "string",
  • "liveness_mode": "passive",
  • "metadata": {
    },
  • "settings": {
    }
}

Response samples

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

session list

Session list for identity authentication.

Authorizations:
oauth2
Request Body schema: application/json
take
number
skip
number
string or Array of strings
string or Array of strings
string or Array of strings
search_term
string
verified
boolean
status
string
Enum: "unknown" "in_progress" "complete" "temporarily_blocked" "temporarily_complete" "expired"
start_date
string or null
end_date
string or null
object

Responses

Request samples

Content type
application/json
{
  • "take": 0,
  • "skip": 0,
  • "identity_id": "string",
  • "client_id": "string",
  • "user_id": "string",
  • "search_term": "string",
  • "verified": true,
  • "status": "unknown",
  • "start_date": "string",
  • "end_date": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "sessions": [
    ],
  • "meta_counts": {
    }
}

session read

Session read for identity authentication.

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "session_id": "string",
  • "user_id": "string",
  • "client_id": "string",
  • "idv_weights_id": "string",
  • "status_e": "unknown",
  • "created_at": "string",
  • "completed_at": "string",
  • "identity_id": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "suffix_name": "string",
  • "liveness_detected": true,
  • "liveness_detected_at": "string",
  • "selfie_given": true,
  • "selfie_given_at": "string",
  • "authenticated": true,
  • "metadata": {
    },
  • "webhook_url": "string",
  • "settings": {
    },
  • "history": [
    ]
}

download ida document

Download ida document.

Authorizations:
oauth2
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
null

session read

Session read for identity authentication.

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "session_id": "string",
  • "identity_id": "string",
  • "user_id": "string",
  • "client_id": "string",
  • "status_e": "unknown",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "suffix_name": "string",
  • "liveness_detected": true,
  • "liveness_detected_at": "string",
  • "selfie_given": true,
  • "selfie_given_at": "string",
  • "authenticated": true,
  • "liveness_provider_e": "azure",
  • "sdk_metadata": {
    }
}

IDA SDK

sdk metadata update

SDK metadata update.

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "sdk_metadata": {
    }
}

Response samples

Content type
application/json
{ }

sdk liveness session generate

SDK access to generate a liveness session

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string
latitude
required
number
longitude
required
number

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

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

sdk liveness session process

SDK access to process a liveness session

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string
latitude
required
number
longitude
required
number
images
Array of strings

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "images": [
    ]
}

Response samples

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

identity authentication finalize

Identity Authentication finalize

Authorizations:
oauth2
header Parameters
X-Client-Id
required
string
Request Body schema: application/json
session_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Identity

list identities

List identities.

Authorizations:
oauth2
Request Body schema: application/json
string or Array of strings
string or Array of strings
search_term
string
take
number
skip
number
start_date
string <date-time>
end_date
string <date-time>
object

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "user_id": "string",
  • "search_term": "string",
  • "take": 0,
  • "skip": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "identities": [
    ],
  • "meta_counts": {
    }
}

anonymize identity

Anonymize identity.

Authorizations:
oauth2
Request Body schema: application/json
identity_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{ }

read identities

Read identities.

Authorizations:
oauth2
Request Body schema: application/json
string or Array of strings
identity_ids
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "identity_id": "string",
  • "identity_ids": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "identities": [
    ],
  • "identity_id": "string",
  • "created_at": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "suffix_name": "string",
  • "birth_date": "string",
  • "gender_e": "unknown",
  • "street": "string",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "document_front_given": true,
  • "document_front_given_at": "string",
  • "verified": true,
  • "verified_at": "string",
  • "liveness_detected": true,
  • "liveness_detected_at": "string",
  • "ofac_status_e": "unknown",
  • "ofac_detected_at": "string",
  • "dmv_status_e": "unknown",
  • "dmv_detected_at": "string",
  • "score": 0
}

get identity status for sdk

Gets the identity status for a identity for sdk use.

Authorizations:
oauth2
Request Body schema: application/json
identity_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "verified": true
}

read completed identity document

Read completed identity document.

Authorizations:
oauth2
Request Body schema: application/json
identity_id
required
string
document_type_e
required
string
Enum: "unknown" "driver_license" "identification_card" "passport" "passport_card"

Responses

Request samples

Content type
application/json
{
  • "identity_id": "string",
  • "document_type_e": "unknown"
}

Response samples

Content type
application/json
{
  • "document_id": "string",
  • "document_type_e": "unknown",
  • "document_data_source_e": "unknown",
  • "document_number": "string",
  • "issue_date": "string",
  • "expiration_date": "string",
  • "ref_number": "string",
  • "issuing_country": "string",
  • "issuing_state": "string",
  • "birth_date": "string",
  • "gender_e": "unknown",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "suffix_name": "string",
  • "street": "string",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "height": "string",
  • "weight": "string",
  • "eye_color": "string",
  • "hair_color": "string"
}

read identity image

Read identity image.

Authorizations:
oauth2
Request Body schema: application/json
identity_id
required
string
storage_file_type_e
required
string
Enum: "unknown" "driver_license_front" "driver_license_back" "state_id_card_front" "state_id_card_back" "passport_front" "passport_card_front" "passport_card_back" "selfie" "liveness_passive" "liveness_active_step_1" "liveness_active_step_2" "liveness_active_step_3" "liveness_active_step_4"

Responses

Request samples

Content type
application/json
{
  • "identity_id": "string",
  • "storage_file_type_e": "unknown"
}

Response samples

Content type
application/json
null

Webhook

webhook create

Webhook create.

Authorizations:
oauth2
Request Body schema: application/json
client_id
string
name
required
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "name": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{ }

webhook list

Webhook list.

Authorizations:
oauth2
Request Body schema: application/json
client_id
string
take
number
skip
number
search_term
string

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "take": 0,
  • "skip": 0,
  • "search_term": "string"
}

Response samples

Content type
application/json
{
  • "webhooks": [
    ],
  • "statistics": {
    }
}

webhook delete

Webhook delete.

Authorizations:
oauth2
Request Body schema: application/json
id
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{ }