Create and run a verification
POST
/run_verifications/
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/run_verifications/' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"phone": "+6412312312",
"email": "abc@example.com",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"birth_date": null,
"unit_no": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"latitude": "string",
"longitude": "string",
"national_id": "string",
"national_id_secondary": "string",
"national_id_tertiary": "string",
"national_id_type": "TAX",
"national_id_secondary_type": "TAX",
"national_id_tertiary_type": "TAX",
"national_id_country_code": "AU",
"algorithm_to_use": "2x1_no_address",
"country_code": "AT",
"callback_url": "https://realaml.com",
"group_verification_signature_key": "string",
"group_via_metadata_key": "string",
"notify_email": "abc@example.com",
"redirect_url": "https://realaml.com",
"org_name": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"notes": "string",
"reference": "string",
"dia_code": "string",
"dvs_code": "string",
"ca_code": "string",
"type": "quick_id",
"facematch_collect_secondary_id": true,
"facematch_run_pep": true,
"run_mobile_2fa": true,
"run_bank_ownership": true,
"run_phone_ownership": true,
"run_bank_phone_ownership": true,
"ca_title_insurance_consent": true,
"pep_type": "RESIDENTIAL",
"consent": true,
"id_front": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A4AAP0A+UVSPqEAAAAASUVORK5CYII=",
"id_back": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A4AAP0A+UVSPqEAAAAASUVORK5CYII=",
"id_secondary_front": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A4AAP0A+UVSPqEAAAAASUVORK5CYII=",
"id_secondary_back": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A4AAP0A+UVSPqEAAAAASUVORK5CYII="
}'Response Response Example
201 - Example 1
{
"signature_key": "string",
"url": "http://example.com",
"type": "quick_id",
"email": "user@example.com",
"phone": "+6412312312",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"contact_name": "string",
"birth_date": "1985-12-30",
"country": "string",
"unit_no": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"latitude": "string",
"longitude": "string",
"other_countries": [
"string"
],
"national_id": "string",
"national_id_secondary": "string",
"national_id_tertiary": "string",
"national_id_type": "TAX",
"national_id_secondary_type": "TAX",
"national_id_tertiary_type": "TAX",
"created_at": "2019-08-24T14:15:22.123Z",
"org_name": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"algorithm_to_use": "2x1_no_address",
"algorithm_used": "2x1_no_address",
"notes": "string",
"reference": "string",
"unique_ip_addresses": [
"string"
],
"quick_id_completed_at": "2019-08-24T14:15:22.123Z",
"facematch_completed_at": "2019-08-24T14:15:22.123Z",
"completed_at": "2019-08-24T14:15:22.123Z",
"consented_at": "2019-08-24T14:15:22.123Z",
"final_report_pdf_url_TEMP": "string",
"report_pdf_url_TEMP": "string",
"redacted_report_pdf_url_TEMP": "string",
"result": "PASS",
"is_cancelled": true,
"is_completed": true,
"is_id_verification_completed": true,
"is_quick_id_completed": true,
"quick_id_is_completed": true,
"result_sources": [
{
"label": "string",
"national_id_type": "TAX",
"name": "PASS",
"birth_date": "PASS",
"address": "PASS",
"country_code": "string"
}
],
"quick_id_result_sources": [
{
"label": "string",
"national_id_type": "TAX",
"name": "PASS",
"birth_date": "PASS",
"address": "PASS",
"country_code": "string"
}
],
"name_result": "PASS",
"quick_id_name_result": "PASS",
"birth_date_result": "PASS",
"quick_id_birth_date_result": "PASS",
"address_result": "PASS",
"quick_id_address_result": "PASS",
"overall_result": "PASS",
"quick_id_overall_result": "PASS",
"pep_result": "NO_MATCH",
"pep_overall_result": "NO_MATCH",
"quick_id_user_overrode_result": true,
"pep_user_overrode_result": true,
"facematch_user_overrode_result": true,
"pep_notes": "string",
"pep_hits": [
{
"name": "string",
"title": "string",
"country": "string",
"risk_types": "string",
"birth_date": "string",
"matched_fields": "string",
"match_percentage": "string",
"deceased": "string",
"links": [
"string"
],
"pdf_links": [
"string"
],
"images": [
"string"
],
"roles": [
"string"
],
"nationalities": [
"string"
],
"locations": [
"string"
],
"official_lists": [
"string"
],
"disqualified_directors": [
"string"
],
"profile_of_interests": [
"string"
]
}
],
"bank_verification_result": "PASS",
"mobile_verification_result": "PASS",
"mobile_number_verified": "string",
"pep_type": "RESIDENTIAL",
"is_facematch_completed": true,
"facematch_is_completed": true,
"facematch_identity_document_result": "PASS",
"facematch_secondary_document_result": "PASS",
"facematch_data_comparison_result": "PASS",
"facematch_document_expiry_result": "PASS",
"facematch_anti_tamper_result": "PASS",
"facematch_photo_liveliness_result": "PASS",
"facematch_face_comparison_result": "PASS",
"facematch_secondary_face_comparison_result": "PASS",
"facematch_id_doc_liveliness_result": "PASS",
"facematch_id_doc_not_printed_result": "PASS",
"facematch_id_doc_photo_overlay_result": "PASS",
"facematch_agency_duplicate_result": "PASS",
"facematch_anti_fraud_result": "PASS",
"facematch_portraits_comparison_result": "PASS",
"facematch_mrz_result": "PASS",
"facematch_portrait_age_result": "PASS",
"facematch_public_figure_result": "PASS",
"facematch_overall_result": "PASS",
"facematch_first_name_OCR_result": true,
"facematch_last_name_OCR_result": true,
"facematch_birth_date_OCR_result": true,
"facematch_document_OCR_check": true,
"facematch_matched_public_figures": [
"string"
],
"facematch_duplicate_signature_keys": [
"string"
],
"facematch_portrait_age_range": [
0
],
"facematch_id_type": "string",
"facematch_id_secondary_type": "string",
"facematch_id_country": "string",
"facematch_id_expiry": "string",
"facematch_ocr_data": {
"full_name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"birth_date": "1985-12-30",
"expiry_date": "1985-12-30",
"issue_date": "1985-12-30",
"issuing_authority": "string",
"national_id": "string",
"national_id_type": "TAX",
"national_id_secondary": "string",
"national_id_secondary_type": "TAX",
"national_id_tertiary": "string",
"national_id_tertiary_type": "TAX",
"national_id_country_code": "AU",
"country_name": "string",
"country_code": "string",
"unit_no": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string"
},
"facematch_id_secondary_ocr_data": {
"full_name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"birth_date": "1985-12-30",
"expiry_date": "1985-12-30",
"issue_date": "1985-12-30",
"issuing_authority": "string",
"national_id": "string",
"national_id_type": "TAX",
"national_id_secondary": "string",
"national_id_secondary_type": "TAX",
"national_id_tertiary": "string",
"national_id_tertiary_type": "TAX",
"national_id_country_code": "AU",
"country_name": "string",
"country_code": "string",
"unit_no": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string"
},
"facematch_mrz_validated": true,
"facematch_id_front_url_TEMP": "string",
"facematch_id_back_url_TEMP": "string",
"facematch_id_secondary_front_url_TEMP": "string",
"facematch_id_secondary_back_url_TEMP": "string",
"facematch_id_front_original_url_TEMP": "string",
"facematch_id_back_original_url_TEMP": "string",
"facematch_id_secondary_front_original_url_TEMP": "string",
"facematch_id_secondary_back_original_url_TEMP": "string",
"facematch_face_from_id_url_TEMP": "string",
"facematch_face_from_selfie_url_TEMP": "string",
"facematch_face_from_liveness_url_TEMP": "string",
"facematch_selfie_url_TEMP": "string",
"facematch_liveness_url_TEMP": "string",
"facematch_liveness_video1_url_TEMP": "string",
"facematch_liveness_video2_url_TEMP": "string",
"facematch_liveness_probability": 0,
"facematch_liveness_quality": 0,
"voi_is_completed": true,
"voi_user_overrode_result": true,
"voi_identity_document_result": "PASS",
"voi_data_result": "PASS",
"voi_id_doc_liveliness_result": "PASS",
"voi_id_doc_not_printed_result": "PASS",
"voi_id_doc_photo_overlay_result": "PASS",
"voi_photo_liveliness_result": "PASS",
"voi_face_comparison_result": "PASS",
"voi_overall_result": "PASS",
"voi_id_type": "string",
"voi_id_secondary_type": "string",
"voi_id_tertiary_type": "string",
"voi_name_change_type": "string",
"voi_ocr_data": {
"full_name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"birth_date": "1985-12-30",
"expiry_date": "1985-12-30",
"issue_date": "1985-12-30",
"issuing_authority": "string",
"national_id": "string",
"national_id_type": "TAX",
"national_id_secondary": "string",
"national_id_secondary_type": "TAX",
"national_id_tertiary": "string",
"national_id_tertiary_type": "TAX",
"national_id_country_code": "AU",
"country_name": "string",
"country_code": "string",
"unit_no": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string"
},
"voi_ocr_secondary_data": {
"full_name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"birth_date": "1985-12-30",
"expiry_date": "1985-12-30",
"issue_date": "1985-12-30",
"issuing_authority": "string",
"national_id": "string",
"national_id_type": "TAX",
"national_id_secondary": "string",
"national_id_secondary_type": "TAX",
"national_id_tertiary": "string",
"national_id_tertiary_type": "TAX",
"national_id_country_code": "AU",
"country_name": "string",
"country_code": "string",
"unit_no": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string"
},
"voi_id_front_url_TEMP": "string",
"voi_id_back_url_TEMP": "string",
"voi_id_secondary_front_url_TEMP": "string",
"voi_id_secondary_back_url_TEMP": "string",
"voi_id_tertiary_front_url_TEMP": "string",
"voi_id_tertiary_back_url_TEMP": "string",
"voi_name_change_url_TEMP": "string",
"voi_face_from_id_url_TEMP": "string",
"voi_face_from_liveness_url_TEMP": "string",
"voi_liveness_url_TEMP": "string",
"voi_liveness_video1_url_TEMP": "string",
"voi_liveness_video2_url_TEMP": "string",
"risk_rating_risk_level": "string",
"risk_rating_risk_score": 0,
"risk_rating_pending_id": "string",
"risk_rating_pending_url": "string"
}