{ "openapi": "3.0.0", "info": { "title": "Onfido Public API v3.6", "version": "1.0.0", "description": "The Onfido Public API (v3.6)\n\nContact Support:\n Name: Onfido" }, "servers": [ { "url": "https://api.{{region}}.onfido.com/v3.6" } ], "paths": { "/applicants": { "get": { "summary": "List Applicants", "parameters": [ { "name": "page", "in": "query", "description": "The page to return. The first page is `page=1`", "schema": { "type": "integer" }, "example": 1 }, { "name": "per_page", "in": "query", "description": "The number of objects per page.", "schema": { "type": "integer" }, "example": 20 }, { "name": "include_deleted", "in": "query", "description": "Whether to also include applicants scheduled for deletion.", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "A list of applicants", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "id_numbers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "state_code": { "type": "string" } } } }, "phone_number": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "delete_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "sandbox": { "type": "boolean" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "postcode": { "type": "string" }, "flat_number": { "type": "string" }, "building_number": { "type": "string" }, "building_name": { "type": "string" }, "street": { "type": "string" }, "sub_street": { "type": "string" }, "town": { "type": "string" }, "state": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" } } }, "location": { "type": "object", "properties": { "ip_address": { "type": "string" }, "country_of_residence": { "type": "string" } } } } } } } }, "example": { "applicants": [ { "id": "b138f237-2b84-3d53-adb0-a3ab6f1071ea", "email": "string", "dob": "2009-07-04", "id_numbers": [ { "type": "tax_id", "value": "string", "state_code": "string" }, { "type": "passport", "value": "string", "state_code": "string" } ], "phone_number": "string", "first_name": "i", "last_name": "u.&\\1", "created_at": "2000-12-02T14:06:32.778Z", "delete_at": "2013-05-27T06:32:52.331Z", "href": "string", "sandbox": false, "address": { "country": "HND", "postcode": "string", "flat_number": "string", "building_number": "string", "building_name": "string", "street": "string", "sub_street": "string", "town": "string", "state": "string", "line1": "_6", "line2": "a6dmz?d", "line3": "" }, "location": { "ip_address": "string", "country_of_residence": "GBR" } }, { "id": "01f1e734-61bf-c53b-5663-0fc10235268a", "email": "string", "dob": "2001-11-29", "id_numbers": [ { "type": "identity_card", "value": "string", "state_code": "string" }, { "type": "share_code", "value": "string", "state_code": "string" } ], "phone_number": "string", "first_name": ".Q6/-ZmB8", "last_name": ")w+^^", "created_at": "2009-02-20T22:37:59.281Z", "delete_at": "1987-02-04T05:32:57.428Z", "href": "string", "sandbox": false, "address": { "country": "WSM", "postcode": "string", "flat_number": "string", "building_number": "string", "building_name": "string", "street": "string", "sub_street": "string", "town": "string", "state": "string", "line1": "`m/c7z", "line2": "?x-Jx", "line3": "/QC" }, "location": { "ip_address": "string", "country_of_residence": "GBR" } } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Applicants" ], "description": "Lists all applicants you've created, sorted by creation date in descending order.\n" }, "post": { "summary": "Create Applicant", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "id_numbers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "state_code": { "type": "string" } } } }, "phone_number": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "delete_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "sandbox": { "type": "boolean" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "postcode": { "type": "string" }, "flat_number": { "type": "string" }, "building_number": { "type": "string" }, "building_name": { "type": "string" }, "street": { "type": "string" }, "sub_street": { "type": "string" }, "town": { "type": "string" }, "state": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" } } }, "location": { "type": "object", "properties": { "ip_address": { "type": "string" }, "country_of_residence": { "type": "string" } } } } }, "example": { "id": "7012b983-294c-adc3-7f94-527b9f839e41", "email": "string", "dob": "1988-09-20", "id_numbers": [ { "type": "social_insurance", "value": "string", "state_code": "string" }, { "type": "passport", "value": "string", "state_code": "string" } ], "phone_number": "string", "first_name": "Te,teflMv", "last_name": "f6B9To4G3]", "created_at": "1964-09-04T17:25:44.805Z", "delete_at": "1992-09-12T10:26:26.719Z", "href": "string", "sandbox": false, "address": { "country": "GGY", "postcode": "string", "flat_number": "string", "building_number": "string", "building_name": "string", "street": "string", "sub_street": "string", "town": "string", "state": "string", "line1": "1FxP", "line2": "", "line3": "|0[pZ](" }, "location": { "ip_address": "string", "country_of_residence": "GBR" } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Applicants" ], "description": "Creates a single applicant. Returns an applicant object.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "id_numbers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "state_code": { "type": "string" } } } }, "phone_number": { "type": "string" }, "consents": { "type": "array", "items": { "type": "object", "properties": { "granted": { "type": "boolean" }, "name": { "type": "string" } } } }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "postcode": { "type": "string" }, "flat_number": { "type": "string" }, "building_number": { "type": "string" }, "building_name": { "type": "string" }, "street": { "type": "string" }, "sub_street": { "type": "string" }, "town": { "type": "string" }, "state": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" } } }, "location": { "type": "object", "properties": { "ip_address": { "type": "string" }, "country_of_residence": { "type": "string" } } } } }, "example": { "first_name": "", "last_name": "WQ~3B@\\D", "email": "string", "dob": "1982-05-27", "id_numbers": [ { "type": "ssn", "value": "string", "state_code": "string" }, { "type": "passport", "value": "string", "state_code": "string" } ], "phone_number": "string", "consents": [ { "granted": true, "name": "ssn_verification" }, { "granted": true, "name": "privacy_notices_read" } ], "address": { "country": "ATG", "postcode": "string", "flat_number": "string", "building_number": "string", "building_name": "string", "street": "string", "sub_street": "string", "town": "string", "state": "string", "line1": "[", "line2": "EHJj", "line3": "uV4" }, "location": { "ip_address": "string", "country_of_residence": "GBR" } } } } } } }, "/applicants/{applicant_id}": { "delete": { "summary": "Delete Applicant", "responses": { "204": { "description": "No Content" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Applicants" ], "description": "Deletes a single applicant.\n" }, "parameters": [ { "name": "applicant_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ], "get": { "summary": "Retrieve Applicant", "responses": { "200": { "description": "Applicant object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "id_numbers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "state_code": { "type": "string" } } } }, "phone_number": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "delete_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "sandbox": { "type": "boolean" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "postcode": { "type": "string" }, "flat_number": { "type": "string" }, "building_number": { "type": "string" }, "building_name": { "type": "string" }, "street": { "type": "string" }, "sub_street": { "type": "string" }, "town": { "type": "string" }, "state": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" } } }, "location": { "type": "object", "properties": { "ip_address": { "type": "string" }, "country_of_residence": { "type": "string" } } } } }, "example": { "id": "7012b983-294c-adc3-7f94-527b9f839e41", "email": "string", "dob": "1988-09-20", "id_numbers": [ { "type": "social_insurance", "value": "string", "state_code": "string" }, { "type": "passport", "value": "string", "state_code": "string" } ], "phone_number": "string", "first_name": "Te,teflMv", "last_name": "f6B9To4G3]", "created_at": "1964-09-04T17:25:44.805Z", "delete_at": "1992-09-12T10:26:26.719Z", "href": "string", "sandbox": false, "address": { "country": "GGY", "postcode": "string", "flat_number": "string", "building_number": "string", "building_name": "string", "street": "string", "sub_street": "string", "town": "string", "state": "string", "line1": "1FxP", "line2": "", "line3": "|0[pZ](" }, "location": { "ip_address": "string", "country_of_residence": "GBR" } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Applicants" ], "description": "Retrieves a single applicant. Returns an applicant object.\n" }, "put": { "summary": "Update Applicant", "responses": { "200": { "description": "Applicant Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "id_numbers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "state_code": { "type": "string" } } } }, "phone_number": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "delete_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "sandbox": { "type": "boolean" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "postcode": { "type": "string" }, "flat_number": { "type": "string" }, "building_number": { "type": "string" }, "building_name": { "type": "string" }, "street": { "type": "string" }, "sub_street": { "type": "string" }, "town": { "type": "string" }, "state": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" } } }, "location": { "type": "object", "properties": { "ip_address": { "type": "string" }, "country_of_residence": { "type": "string" } } } } }, "example": { "id": "7012b983-294c-adc3-7f94-527b9f839e41", "email": "string", "dob": "1988-09-20", "id_numbers": [ { "type": "social_insurance", "value": "string", "state_code": "string" }, { "type": "passport", "value": "string", "state_code": "string" } ], "phone_number": "string", "first_name": "Te,teflMv", "last_name": "f6B9To4G3]", "created_at": "1964-09-04T17:25:44.805Z", "delete_at": "1992-09-12T10:26:26.719Z", "href": "string", "sandbox": false, "address": { "country": "GGY", "postcode": "string", "flat_number": "string", "building_number": "string", "building_name": "string", "street": "string", "sub_street": "string", "town": "string", "state": "string", "line1": "1FxP", "line2": "", "line3": "|0[pZ](" }, "location": { "ip_address": "string", "country_of_residence": "GBR" } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Applicants" ], "description": "Allows updating applicant's information before any checks is created.\n- Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "id_numbers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "state_code": { "type": "string" } } } }, "phone_number": { "type": "string" }, "consents": { "type": "array", "items": { "type": "object", "properties": { "granted": { "type": "boolean" }, "name": { "type": "string" } } } }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "postcode": { "type": "string" }, "flat_number": { "type": "string" }, "building_number": { "type": "string" }, "building_name": { "type": "string" }, "street": { "type": "string" }, "sub_street": { "type": "string" }, "town": { "type": "string" }, "state": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "line3": { "type": "string" } } }, "location": { "type": "object", "properties": { "ip_address": { "type": "string" }, "country_of_residence": { "type": "string" } } }, "first_name": { "type": "string" }, "last_name": { "type": "string" } } }, "example": { "email": "string", "dob": "1972-07-26", "id_numbers": [ { "type": "driving_license", "value": "string", "state_code": "string" }, { "type": "other", "value": "string", "state_code": "string" } ], "phone_number": "string", "consents": [ { "granted": false, "name": "privacy_notices_read" }, { "granted": false, "name": "ssn_verification" } ], "address": { "country": "ERI", "postcode": "string", "flat_number": "string", "building_number": "string", "building_name": "string", "street": "string", "sub_street": "string", "town": "string", "state": "string", "line1": "sLsztt+", "line2": "UrMn8'CwR", "line3": "I}\"I9mFgV." }, "location": { "ip_address": "string", "country_of_residence": "GBR" }, "first_name": "tB", "last_name": "Jo~ UW3" } } } } } }, "/applicants/{applicant_id}/restore": { "post": { "summary": "Restore Applicant", "responses": { "204": { "description": "No Content" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Applicants" ], "description": "Restores a single applicant scheduled for deletion.\n" }, "parameters": [ { "name": "applicant_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/applicants/{applicant_id}/consents": { "get": { "summary": "Retrieve Applicant Consents", "responses": { "200": { "description": "Applicant Consents object", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "granted": { "type": "boolean" }, "granted_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" } } } }, "example": [ { "granted": true, "granted_at": "1966-03-06T23:47:35.527Z", "name": "phone_number_verification" }, { "granted": false, "granted_at": "1978-01-22T18:57:26.477Z", "name": "privacy_notices_read" } ] } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Applicants" ], "description": "Retrieves consents for single applicant.\n" }, "parameters": [ { "name": "applicant_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/workflow_runs": { "get": { "summary": "List Workflow Runs", "parameters": [ { "name": "page", "in": "query", "description": "The number of the page to be retrieved. If not specified, defaults to 1.", "schema": { "type": "integer" }, "example": 1 }, { "name": "status", "in": "query", "description": "A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'.", "schema": { "type": "string" }, "example": "string" }, { "name": "created_at_gt", "in": "query", "description": "A ISO-8601 date to filter results with a created date greater than (after) the one provided.", "schema": { "type": "string" }, "example": "1970-10-07" }, { "name": "created_at_lt", "in": "query", "description": "A ISO-8601 date to filter results with a created date less than (before) the one provided.", "schema": { "type": "string" }, "example": "1970-10-07" }, { "name": "sort", "in": "query", "description": "A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. (This can only be one of desc,asc)", "schema": { "type": "string" }, "example": "desc" }, { "name": "applicant_id", "in": "query", "description": "the applicant's id.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" }, { "name": "tags", "in": "query", "description": "A list of tags to filter the results.", "schema": { "type": "string" }, "example": "string" } ], "responses": { "200": { "description": "An array of Workflow Run objects matching the query parameters.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "id": { "type": "string" }, "workflow_id": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "customer_user_id": { "type": "string" }, "link": { "type": "object", "properties": { "url": { "type": "string" }, "completed_redirect_url": { "type": "string" }, "expired_redirect_url": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "language": { "type": "string" } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "workflow_version_id": { "type": "integer" }, "dashboard_url": { "type": "string" }, "status": { "type": "string" }, "output": { "type": "object" }, "reasons": { "type": "array", "items": { "type": "string" } }, "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } }, "sdk_token": { "type": "string" } } } }, "example": [ { "applicant_id": "a3ba3e0f-5da8-4dad-fa20-f0d4aa04a836", "id": "a8bbb1ae-28b5-e4fc-8509-790c85d0759a", "workflow_id": "949cabb2-116a-f366-b9a4-06ee89567c96", "tags": [ "string", "string" ], "customer_user_id": "string", "link": { "url": "string", "completed_redirect_url": "string", "expired_redirect_url": "string", "expires_at": "1952-04-02T18:36:53.157Z", "language": "es_ES" }, "created_at": "1987-12-01T21:03:26.951Z", "updated_at": "2018-12-25T21:47:44.311Z", "workflow_version_id": 1638, "dashboard_url": "string", "status": "review", "output": {}, "reasons": [ "string", "string" ], "error": { "type": "string", "message": "string" }, "sdk_token": "string" }, { "applicant_id": "6777ff95-822f-a177-539b-7e772789f650", "id": "902ebfab-8a48-195e-3f2d-a5f50beb31d5", "workflow_id": "057b5242-aad5-409a-4a56-49fb95cc3776", "tags": [ "string", "string" ], "customer_user_id": "string", "link": { "url": "string", "completed_redirect_url": "string", "expired_redirect_url": "string", "expires_at": "2002-04-03T10:51:14.104Z", "language": "de_DE" }, "created_at": "2013-01-28T07:22:45.677Z", "updated_at": "2008-11-04T15:45:09.615Z", "workflow_version_id": 7353, "dashboard_url": "string", "status": "approved", "output": {}, "reasons": [ "string", "string" ], "error": { "type": "string", "message": "string" }, "sdk_token": "string" } ] } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Workflow Runs" ], "description": "Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.\n" }, "post": { "summary": "Create a Workflow Run", "responses": { "201": { "description": "A Workflow Run object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "id": { "type": "string" }, "workflow_id": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "customer_user_id": { "type": "string" }, "link": { "type": "object", "properties": { "url": { "type": "string" }, "completed_redirect_url": { "type": "string" }, "expired_redirect_url": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "language": { "type": "string" } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "workflow_version_id": { "type": "integer" }, "dashboard_url": { "type": "string" }, "status": { "type": "string" }, "output": { "type": "object" }, "reasons": { "type": "array", "items": { "type": "string" } }, "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } }, "sdk_token": { "type": "string" } } }, "example": { "applicant_id": "a8a4588e-0f14-b0c6-0325-2e3c6b2c55c5", "id": "96081a87-a5a6-d169-53ed-42af37a78e39", "workflow_id": "a8bdd906-73b3-ebdf-e361-4993f7169026", "tags": [ "st", "string" ], "customer_user_id": "string", "link": { "url": "string", "completed_redirect_url": "string", "expired_redirect_url": "string", "expires_at": "2014-09-23T20:16:36.723Z", "language": "en_US" }, "created_at": "1951-04-24T10:42:31.876Z", "updated_at": "1987-04-08T15:06:13.468Z", "workflow_version_id": 7120, "dashboard_url": "string", "status": "declined", "output": {}, "reasons": [ "string", "string" ], "error": { "type": "string", "message": "string" }, "sdk_token": "string" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Workflow Runs" ], "description": "Creates and starts a Workflow Run. Returns a Workflow Run object.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "workflow_id": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "customer_user_id": { "type": "string" }, "link": { "type": "object", "properties": { "url": { "type": "string" }, "completed_redirect_url": { "type": "string" }, "expired_redirect_url": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "language": { "type": "string" } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "custom_data": { "type": "object", "properties": { "key_0": { "type": "string" }, "key_1": { "type": "number" } } } } }, "example": { "applicant_id": "8a0478ee-dd87-29df-6959-8865b1831e51", "workflow_id": "162765c5-984c-3568-3e11-659ae4e250a3", "tags": [ "string", "s" ], "customer_user_id": "string", "link": { "url": "string", "completed_redirect_url": "string", "expired_redirect_url": "string", "expires_at": "1985-02-15T02:14:15.614Z", "language": "it_IT" }, "created_at": "2020-04-14T13:09:31.168Z", "updated_at": "2019-12-20T15:47:16.167Z", "custom_data": { "key_0": "string", "key_1": 334.4138053928458 } } } } } } }, "/workflow_runs/{workflow_run_id}": { "get": { "summary": "Retrieve Workflow Run", "responses": { "200": { "description": "A Workflow Run object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "id": { "type": "string" }, "workflow_id": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "customer_user_id": { "type": "string" }, "link": { "type": "object", "properties": { "url": { "type": "string" }, "completed_redirect_url": { "type": "string" }, "expired_redirect_url": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "language": { "type": "string" } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "workflow_version_id": { "type": "integer" }, "dashboard_url": { "type": "string" }, "status": { "type": "string" }, "output": { "type": "object" }, "reasons": { "type": "array", "items": { "type": "string" } }, "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } }, "sdk_token": { "type": "string" } } }, "example": { "applicant_id": "a8a4588e-0f14-b0c6-0325-2e3c6b2c55c5", "id": "96081a87-a5a6-d169-53ed-42af37a78e39", "workflow_id": "a8bdd906-73b3-ebdf-e361-4993f7169026", "tags": [ "st", "string" ], "customer_user_id": "string", "link": { "url": "string", "completed_redirect_url": "string", "expired_redirect_url": "string", "expires_at": "2014-09-23T20:16:36.723Z", "language": "en_US" }, "created_at": "1951-04-24T10:42:31.876Z", "updated_at": "1987-04-08T15:06:13.468Z", "workflow_version_id": 7120, "dashboard_url": "string", "status": "declined", "output": {}, "reasons": [ "string", "string" ], "error": { "type": "string", "message": "string" }, "sdk_token": "string" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Workflow Runs" ], "description": "A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.\n" }, "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "(Required) The unique identifier of the Workflow Run.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/workflow_runs/{workflow_run_id}/signed_evidence_file": { "get": { "summary": "Retrieve Workflow Run Evidence Summary File", "responses": { "200": { "description": "The signed evidence PDF binary data." }, "302": { "description": "Found", "headers": { "Location": { "description": "Link to the signed evidence file PDF.", "schema": { "type": "string" }, "example": "http://FQUbHAmvZ.nrMEhhpbnfvep8xYXKj5" } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Workflow Runs" ], "description": "Retrieves the signed evidence file for the designated Workflow Run\n" }, "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "(Required) Workflow Run ID", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/workflow_runs/{workflow_run_id}/evidence_folder": { "get": { "summary": "Retrieve Workflow Run Evidence Folder", "responses": { "200": { "description": "The evidence folder binary data." }, "302": { "description": "Found", "headers": { "Location": { "description": "Link to the evidence folder.", "schema": { "type": "string" }, "example": "http://FQUbHAmvZ.nrMEhhpbnfvep8xYXKj5" } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Workflow Runs" ], "description": "Retrieves the evidence folder for the designated Workflow Run\n" }, "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "(Required) Workflow Run ID", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/documents": { "get": { "summary": "List documents", "parameters": [ { "name": "applicant_id", "in": "query", "description": "(Required) ", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "List of Documents", "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "file_type": { "type": "string" }, "type": { "type": "string" }, "side": { "type": "string" }, "issuing_country": { "type": "string" }, "applicant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" } } } } } }, "example": { "documents": [ { "id": "012d7045-c547-902e-f0ce-6bd70ecf7029", "file_type": "string", "type": "national_health_insurance_card", "side": "back", "issuing_country": "LKA", "applicant_id": "fbcbf96e-29a5-0259-2f95-560a3a85bb58", "created_at": "2004-03-11T21:03:25.574Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 8106 }, { "id": "6fcdd5f4-ee1d-8baf-4b68-d9ae221b903d", "file_type": "string", "type": "marriage_certificate", "side": "back", "issuing_country": "VCT", "applicant_id": "66eb3694-c495-5e27-2d4a-d976a983ba2e", "created_at": "2013-09-28T14:14:39.511Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 5859 } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Documents" ], "description": "All documents belonging to an applicant can be listed from this endpoint" }, "post": { "summary": "Upload a document", "responses": { "201": { "description": "A document", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "file_type": { "type": "string" }, "type": { "type": "string" }, "side": { "type": "string" }, "issuing_country": { "type": "string" }, "applicant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" } } }, "example": { "id": "64e93711-aca7-703b-9df1-efe905eca711", "file_type": "string", "type": "divorce_absolute_decree", "side": "back", "issuing_country": "COK", "applicant_id": "2c54781a-710b-9ff9-92d9-a607630b88ef", "created_at": "1950-05-30T18:47:53.286Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 1241 } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Documents" ], "description": "Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.\n" } }, "/documents/{document_id}": { "get": { "summary": "Retrieve document", "responses": { "200": { "description": "A document", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "file_type": { "type": "string" }, "type": { "type": "string" }, "side": { "type": "string" }, "issuing_country": { "type": "string" }, "applicant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" } } }, "example": { "id": "64e93711-aca7-703b-9df1-efe905eca711", "file_type": "string", "type": "divorce_absolute_decree", "side": "back", "issuing_country": "COK", "applicant_id": "2c54781a-710b-9ff9-92d9-a607630b88ef", "created_at": "1950-05-30T18:47:53.286Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 1241 } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Documents" ], "description": "A single document can be retrieved by calling this endpoint with the document's unique identifier.\n" }, "parameters": [ { "name": "document_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/documents/{document_id}/download": { "get": { "summary": "Download document", "responses": { "200": { "description": "The document binary data" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Documents" ], "description": "Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.\n" }, "parameters": [ { "name": "document_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/documents/{document_id}/nfc_face": { "get": { "summary": "Download NFC face", "responses": { "200": { "description": "The image binary data" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Documents" ], "description": "Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.\n" }, "parameters": [ { "name": "document_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/documents/{document_id}/video/download": { "get": { "summary": "Download document video", "responses": { "200": { "description": "The document's video binary data" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Documents" ], "description": "Downloads a document video. If successful, the response will be the binary data representing the video.\n" }, "parameters": [ { "name": "document_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "string" } ] }, "/signing_documents": { "get": { "summary": "List signing documents", "parameters": [ { "name": "applicant_id", "in": "query", "description": "(Required) ", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "List of Signing Documents", "content": { "application/json": { "schema": { "type": "object", "properties": { "signing_documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "applicant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_type": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" } } } } } }, "example": { "signing_documents": [ { "id": "f08a7bf6-b203-296f-be81-567cf7dd1b64", "applicant_id": "ec04c5d4-3fb4-4d35-6760-e5bd0b75487a", "created_at": "1975-07-08T20:55:54.049Z", "href": "string", "download_href": "string", "file_type": "string", "file_name": "string", "file_size": 8813 }, { "id": "ff930e85-4597-f535-486e-1bab040ec8e6", "applicant_id": "77aac60b-1d96-d1a9-171f-9da07a67ab08", "created_at": "2013-03-03T18:08:36.880Z", "href": "string", "download_href": "string", "file_type": "string", "file_name": "string", "file_size": 5205 } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Signing documents" ], "description": "All signing documents belonging to an applicant can be listed from this endpoint" }, "post": { "summary": "Upload a signing document", "responses": { "201": { "description": "A signing document", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "applicant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_type": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" } } }, "example": { "id": "a6f161fa-b43e-219e-f2e0-2506645304e4", "applicant_id": "62408fa0-1387-c508-f766-c432ba4daeb5", "created_at": "2014-04-10T01:57:26.601Z", "href": "string", "download_href": "string", "file_type": "string", "file_name": "string", "file_size": 330 } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Signing documents" ], "description": "Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.\n" } }, "/signing_documents/{signing_document_id}": { "get": { "summary": "Retrieve signing document", "responses": { "200": { "description": "A signing document", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "applicant_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_type": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" } } }, "example": { "id": "a6f161fa-b43e-219e-f2e0-2506645304e4", "applicant_id": "62408fa0-1387-c508-f766-c432ba4daeb5", "created_at": "2014-04-10T01:57:26.601Z", "href": "string", "download_href": "string", "file_type": "string", "file_name": "string", "file_size": 330 } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Signing documents" ], "description": "A single signing document can be retrieved by calling this endpoint with the signing document's unique identifier.\n" }, "parameters": [ { "name": "signing_document_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/signing_documents/{signing_document_id}/download": { "get": { "summary": "Download signing document", "responses": { "200": { "description": "The signing document binary data" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Signing documents" ], "description": "Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.\n" }, "parameters": [ { "name": "signing_document_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/live_photos": { "get": { "summary": "List live photos", "parameters": [ { "name": "applicant_id", "in": "query", "description": "(Required) The id of the applicant the live photos belong to.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "An array of live photos", "content": { "application/json": { "schema": { "type": "object", "properties": { "live_photos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_type": { "type": "string" }, "file_size": { "type": "integer" } } } } } }, "example": { "live_photos": [ { "id": "8e29f5d1-2418-b817-2de1-cba769fd2e1b", "created_at": "1973-08-10T02:40:04.425Z", "href": "string", "download_href": "string", "file_name": "string", "file_type": "string", "file_size": 9202 }, { "id": "0c8eeaad-cfc5-73de-dea8-29fbb3809ee8", "created_at": "1966-03-12T14:45:19.153Z", "href": "string", "download_href": "string", "file_name": "string", "file_type": "string", "file_size": 6439 } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Live photos" ], "description": "Lists the live photos that belong to an applicant.\n" }, "post": { "summary": "Upload live photo", "responses": { "201": { "description": "The Live Photo", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_type": { "type": "string" }, "file_size": { "type": "integer" } } }, "example": { "id": "7d43fdb0-c64b-4315-69e7-66ddddc0c926", "created_at": "1946-09-04T17:58:05.913Z", "href": "string", "download_href": "string", "file_name": "string", "file_type": "string", "file_size": 1600 } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Live photos" ], "description": "You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.\n" } }, "/live_photos/{live_photo_id}": { "get": { "summary": "Retrieve live photo", "responses": { "200": { "description": "A live photo", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_type": { "type": "string" }, "file_size": { "type": "integer" } } }, "example": { "id": "7d43fdb0-c64b-4315-69e7-66ddddc0c926", "created_at": "1946-09-04T17:58:05.913Z", "href": "string", "download_href": "string", "file_name": "string", "file_type": "string", "file_size": 1600 } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Live photos" ], "description": "Retrieves a single live photo. Returns a live photo object.\n" }, "parameters": [ { "name": "live_photo_id", "in": "path", "required": true, "description": "(Required) The live photo's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/live_photos/{live_photo_id}/download": { "get": { "summary": "Download live photo", "responses": { "200": { "description": "The live photo's binary data." }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Live photos" ], "description": "Live photos are downloaded using this endpoint." }, "parameters": [ { "name": "live_photo_id", "in": "path", "required": true, "description": "(Required) The live photo's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/live_videos": { "get": { "summary": "List live videos", "parameters": [ { "name": "applicant_id", "in": "query", "description": "(Required) The id of the applicant the live videos belong to.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "An array of live videos", "content": { "application/json": { "schema": { "type": "object", "properties": { "live_videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" }, "file_type": { "type": "string" }, "challenge": { "type": "array", "items": { "type": "object", "properties": { "key_0": { "type": "string" } } } } } } } } }, "example": { "live_videos": [ { "id": "6c8c9ed7-f254-21a8-e59a-1fee1c6ffaec", "created_at": "1997-12-08T21:41:18.565Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 5063, "file_type": "string", "challenge": [ { "key_0": "string" }, { "key_0": 7767.631250969996 } ] }, { "id": "39f0aeb8-5897-e33b-10f5-72e4bd9c5f8b", "created_at": "1975-04-02T23:09:17.201Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 6257, "file_type": "string", "challenge": [ { "key_0": true, "key_1": 4244.804079319171 }, { "key_0": 7961 } ] } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Live videos" ], "description": "Lists all the live videos that belong to an applicant.\n" } }, "/live_videos/{live_video_id}": { "get": { "summary": "Retrieve live video", "responses": { "200": { "description": "A live video", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" }, "file_type": { "type": "string" }, "challenge": { "type": "array", "items": { "type": "object", "properties": { "key_0": { "type": "boolean" } } } } } }, "example": { "id": "0a779457-376e-4b23-8542-14bfa02a50cf", "created_at": "1990-05-26T03:26:32.848Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 9860, "file_type": "string", "challenge": [ { "key_0": false }, { "key_0": "string", "key_1": 3779.646438731339 } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Live videos" ], "description": "Retrieves a single live video. Returns the corresponding live video object.\n" }, "parameters": [ { "name": "live_video_id", "in": "path", "required": true, "description": "(Required) The live video's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/live_videos/{live_video_id}/download": { "get": { "summary": "Download live video", "responses": { "200": { "description": "The live video's binary data." }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Live videos" ], "description": "Live videos are downloaded using this endpoint." }, "parameters": [ { "name": "live_video_id", "in": "path", "required": true, "description": "(Required) The live video's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/live_videos/{live_video_id}/frame": { "get": { "summary": "Download live video frame", "responses": { "200": { "description": "The live video frame's binary data." }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Live videos" ], "description": "Returns the binary data representing a single frame from a live video." }, "parameters": [ { "name": "live_video_id", "in": "path", "required": true, "description": "(Required) The live video's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/workflow_runs/{workflow_run_id}/tasks": { "get": { "summary": "List Tasks", "responses": { "200": { "description": "An array of subset Task objects that were already started or completed, ordered by the created_at field, in ascending order.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workflow_run_id": { "type": "string" }, "task_def_id": { "type": "string" }, "task_def_version": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "example": [ { "id": "profile_123", "workflow_run_id": "63ef490d-0297-79fc-e96d-7051bd7dbaca", "task_def_id": "task_123", "task_def_version": "string", "created_at": "2016-06-23T00:14:42.458Z", "updated_at": "1986-03-07T15:23:10.537Z" }, { "id": "profile_123", "workflow_run_id": "c7eeb174-21cb-0adb-de1e-d49695636bf0", "task_def_id": "task_123", "task_def_version": "string", "created_at": "1976-05-21T19:31:25.184Z", "updated_at": "1973-08-05T11:13:07.546Z" } ] } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Tasks" ], "description": "The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.\n" }, "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "(Required) The unique identifier of the Workflow Run to which the Tasks belong.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/workflow_runs/{workflow_run_id}/tasks/{task_id}": { "get": { "summary": "Retrieve Task", "responses": { "200": { "description": "A Task object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workflow_run_id": { "type": "string" }, "task_def_id": { "type": "string" }, "task_def_version": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "example": { "id": "profile_123", "workflow_run_id": "adac5bf6-1a25-b476-8ca7-611bc1cb9c31", "task_def_id": "task_123", "task_def_version": "string", "input": {}, "output": {}, "created_at": "1995-10-12T06:32:57.300Z", "updated_at": "1994-11-11T09:26:54.841Z" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Tasks" ], "description": "A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.\n" }, "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "(Required) The unique identifier of the Workflow Run to which the Task belongs.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" }, { "name": "task_id", "in": "path", "required": true, "description": "(Required) The identifier of the Task you want to retrieve.", "schema": { "type": "string" }, "example": "string" } ] }, "/workflow_runs/{workflow_run_id}/tasks/{task_id}/complete": { "post": { "summary": "Complete Task", "responses": { "200": { "description": "An empty response body." }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Tasks" ], "description": "Completes a Send / Receive Data Task.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} } } }, "example": { "data": [] } } } } }, "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "(Required) The unique identifier of the Workflow Run to which the Task belongs.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" }, { "name": "task_id", "in": "path", "required": true, "description": "(Required) The identifier of the Task you want to complete.", "schema": { "type": "string" }, "example": "string" } ] }, "/motion_captures": { "get": { "summary": "List motion captures", "parameters": [ { "name": "applicant_id", "in": "query", "description": "(Required) The id of the applicant the motion captures belong to.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "An array of motion captures", "content": { "application/json": { "schema": { "type": "object", "properties": { "motion_captures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" }, "file_type": { "type": "string" } } } } } }, "example": { "motion_captures": [ { "id": "d4f53246-2224-0c2a-66a9-b6b7b03eb084", "created_at": "1951-03-29T05:56:38.517Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 9928, "file_type": "string" }, { "id": "6920577b-dc53-7233-feb7-d1ab91ed625a", "created_at": "1989-09-15T22:49:51.634Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 3083, "file_type": "string" } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Motion captures" ], "description": "Lists all the motion captures that belong to an applicant.\n" } }, "/motion_captures/{motion_capture_id}": { "get": { "summary": "Retrieve motion capture", "responses": { "200": { "description": "A motion capture", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" }, "file_type": { "type": "string" } } }, "example": { "id": "410a7228-21b5-80b9-9595-3d25bfca9dc7", "created_at": "1955-04-26T15:57:43.966Z", "href": "string", "download_href": "string", "file_name": "string", "file_size": 9839, "file_type": "string" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Motion captures" ], "description": "Retrieves a single motion capture. Returns the corresponding motion capture object.\n" }, "parameters": [ { "name": "motion_capture_id", "in": "path", "required": true, "description": "(Required) The motion capture's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/motion_captures/{motion_capture_id}/download": { "get": { "summary": "Download motion capture", "responses": { "200": { "description": "The motion capture's binary data." }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Motion captures" ], "description": "Motion captures are downloaded using this endpoint." }, "parameters": [ { "name": "motion_capture_id", "in": "path", "required": true, "description": "(Required) The motion capture's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/motion_captures/{motion_capture_id}/frame": { "get": { "summary": "Download motion capture frame", "responses": { "200": { "description": "The motion capture frame's binary data." }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Motion captures" ], "description": "Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame." }, "parameters": [ { "name": "motion_capture_id", "in": "path", "required": true, "description": "(Required) The motion capture's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/biometric_tokens/{user_id}": { "delete": { "summary": "Invalidate biometric tokens", "responses": { "200": { "description": "Biometric tokens invalidated", "content": { "application/json": { "schema": { "type": "object", "properties": { "biometric_tokens": { "type": "object", "properties": { "deleted_items": { "type": "object", "properties": { "count": { "type": "integer" } } } } } } }, "example": { "biometric_tokens": { "deleted_items": { "count": 6168 } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Biometric tokens" ], "description": "Invalidates every biometric token associated with the supplied customer user ID.\n" }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "description": "(Required) Customer user ID that owns the biometric tokens.", "schema": { "type": "string" }, "example": "string" } ], "get": { "summary": "List biometric tokens", "responses": { "200": { "description": "Biometric tokens belonging to the user", "content": { "application/json": { "schema": { "type": "object", "properties": { "biometric_tokens": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "inserted_at": { "type": "string", "format": "date-time" }, "media_type": { "type": "string" }, "status": { "type": "string" } } }, "uuid": { "type": "string" } } } } } }, "example": { "biometric_tokens": [ { "data": { "inserted_at": "2021-08-10T01:48:47.365Z", "media_type": "string", "status": "approved" }, "uuid": "dae4cfbf-f4ca-481c-4314-65d9ae13d42d" }, { "data": { "inserted_at": "1993-05-29T05:54:34.241Z", "media_type": "string", "status": "declined" }, "uuid": "714851b5-4844-fcda-7f3b-fc0cff639020" } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Biometric tokens" ], "description": "Returns the biometric tokens associated with the supplied customer user ID.\n" } }, "/biometric_tokens/{user_id}/{token_uuid}": { "delete": { "summary": "Invalidate biometric token", "responses": { "200": { "description": "Biometric token invalidated", "content": { "application/json": { "schema": { "type": "object", "properties": { "biometric_token": { "type": "object", "properties": { "deleted_items": { "type": "object", "properties": { "count": { "type": "integer" } } } } } } }, "example": { "biometric_token": { "deleted_items": { "count": 4290 } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Biometric tokens" ], "description": "Invalidates a biometric token.\n" }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "description": "(Required) Customer user ID that owns the biometric token.", "schema": { "type": "string" }, "example": "string" }, { "name": "token_uuid", "in": "path", "required": true, "description": "(Required) Biometric token UUID.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ], "get": { "summary": "Retrieve biometric token", "responses": { "200": { "description": "The requested biometric token", "content": { "application/json": { "schema": { "type": "object", "properties": { "biometric_token": { "type": "object", "properties": { "data": { "type": "object", "properties": { "inserted_at": { "type": "string", "format": "date-time" }, "media_type": { "type": "string" }, "status": { "type": "string" } } }, "uuid": { "type": "string" } } } } }, "example": { "biometric_token": { "data": { "inserted_at": "2003-01-15T09:57:03.561Z", "media_type": "string", "status": "awaiting_input" }, "uuid": "1bd7ba39-e55b-c396-110b-20bb3a8eee6f" } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Biometric tokens" ], "description": "Returns a biometric token's details.\n" }, "put": { "summary": "Update biometric token", "responses": { "200": { "description": "Biometric token updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "biometric_token": { "type": "object", "properties": { "data": { "type": "object", "properties": { "inserted_at": { "type": "string", "format": "date-time" }, "media_type": { "type": "string" }, "status": { "type": "string" } } }, "uuid": { "type": "string" } } } } }, "example": { "biometric_token": { "data": { "inserted_at": "1981-10-07T12:51:14.745Z", "media_type": "string", "status": "processing" }, "uuid": "2b87efd2-88c2-3db8-1d91-f99b1d81cc5c" } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Biometric tokens" ], "description": "Updates a biometric token's status.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" } } }, "example": { "status": "declined" } } } } } }, "/watchlist_monitors": { "get": { "summary": "List monitors", "parameters": [ { "name": "applicant_id", "in": "query", "description": "(Required) The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" }, { "name": "include_deleted", "in": "query", "description": "Whether to also include deleted (inactive) monitors.", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "An array of watchlist monitors", "content": { "application/json": { "schema": { "type": "object", "properties": { "monitors": { "type": "array", "items": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "id": { "type": "string" }, "report_name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time" }, "is_sandbox": { "type": "boolean" } } } } } }, "example": { "monitors": [ { "applicant_id": "d9614355-248f-9220-656f-337e41ad364a", "id": "836cb244-2b70-4180-4628-11637f88b95c", "report_name": "watchlist_aml", "tags": [ "string", "string" ], "created_at": "1979-01-20T16:46:28.902Z", "deleted_at": "1985-12-11T06:56:16.561Z", "is_sandbox": false }, { "applicant_id": "80d74149-1f62-829e-35b9-94291d809381", "id": "c09555b8-a39b-686d-5732-d87442165bc8", "report_name": "watchlist_aml", "tags": [ "string", "string" ], "created_at": "2012-08-15T11:07:41.050Z", "deleted_at": "1974-04-04T04:09:51.654Z", "is_sandbox": false } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Monitors" ], "description": "List all available monitors for an applicant\n" }, "post": { "summary": "Create monitor", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "id": { "type": "string" }, "report_name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time" }, "is_sandbox": { "type": "boolean" } } }, "example": { "applicant_id": "83bc7e06-49e2-3936-ae03-f3ba9a2c0101", "id": "fc49b4b6-f7d5-58e2-659b-17dec712ebae", "report_name": "watchlist_standard", "tags": [ "string", "string" ], "created_at": "2001-04-09T00:09:32.452Z", "deleted_at": "1949-07-04T13:50:14.529Z", "is_sandbox": false } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Monitors" ], "description": "Creates a new monitor for the applicant\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "report_name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "example": { "applicant_id": "03c46fca-d8e9-cd97-219a-ee4b942a506f", "report_name": "watchlist_standard", "tags": [ "string", "string" ] } } } } } }, "/watchlist_monitors/{monitor_id}": { "delete": { "summary": "Delete monitor", "responses": { "204": { "description": "No Content" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Monitors" ], "description": "Deactivates the given monitor\n" }, "parameters": [ { "name": "monitor_id", "in": "path", "required": true, "description": "(Required) The watchlist monitor's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ], "get": { "summary": "Retrieve monitor", "responses": { "200": { "description": "A watchlist monitor", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "id": { "type": "string" }, "report_name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time" }, "is_sandbox": { "type": "boolean" } } }, "example": { "applicant_id": "83bc7e06-49e2-3936-ae03-f3ba9a2c0101", "id": "fc49b4b6-f7d5-58e2-659b-17dec712ebae", "report_name": "watchlist_standard", "tags": [ "string", "string" ], "created_at": "2001-04-09T00:09:32.452Z", "deleted_at": "1949-07-04T13:50:14.529Z", "is_sandbox": false } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Monitors" ], "description": "Retrieves a single monitor\n" } }, "/watchlist_monitors/{monitor_id}/matches": { "get": { "summary": "List matches (BETA)", "responses": { "200": { "description": "An array of watchlist monitors", "content": { "application/json": { "schema": { "type": "object", "properties": { "matches": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" } } } } } }, "example": { "matches": [ { "id": "84415038-8d72-b6d7-7196-2253491b460f", "enabled": false }, { "id": "380e2c27-d6ae-9fa3-aa0c-0c6c204aac44", "enabled": true } ] } } } } }, "tags": [ "Core Resources", "Monitors" ], "description": "List match IDs on this monitor, as well as their enabled/disabled status\n" }, "parameters": [ { "name": "monitor_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ], "patch": { "summary": "Set match status (BETA)", "responses": { "200": { "description": "An array of watchlist monitors", "content": { "application/json": { "schema": { "type": "object", "properties": { "matches": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" } } } } } }, "example": { "matches": [ { "id": "84415038-8d72-b6d7-7196-2253491b460f", "enabled": false }, { "id": "380e2c27-d6ae-9fa3-aa0c-0c6c204aac44", "enabled": true } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Monitors" ], "description": "Update the status of the given matches\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enable": { "type": "array", "items": { "type": "string" } }, "disable": { "type": "array", "items": { "type": "string" } } } }, "example": { "enable": [ "c01b2248-6511-fdbe-3786-79d901c27b60", "2e7b6ead-692d-0071-2cce-54ff6fb20346" ], "disable": [ "660efa39-2278-b555-e12c-db11f3681566", "cf325d2a-4ed2-8cb7-d0ea-6a8fb008c9b1" ] } } } } } }, "/watchlist_monitors/{monitor_id}/new_report": { "post": { "summary": "Force new report creation (BETA)", "responses": { "201": { "description": "Created", "headers": { "Location": { "description": "Link to the newly generated report.", "schema": { "type": "string" }, "example": "string" } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Monitors" ], "description": "Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.\n" }, "parameters": [ { "name": "monitor_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/id_photos": { "get": { "summary": "List ID photos", "parameters": [ { "name": "applicant_id", "in": "query", "description": "(Required) The id of the applicant the ID photos belong to.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "An array of ID photos", "content": { "application/json": { "schema": { "type": "object", "properties": { "id_photos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_type": { "type": "string" }, "file_size": { "type": "integer" } } } } } }, "example": { "id_photos": [ { "id": "fd21637c-82db-d30e-01c6-4dd19f5d619d", "created_at": "1948-04-21T10:57:03.505Z", "href": "string", "download_href": "string", "file_name": "string", "file_type": "string", "file_size": 9036 }, { "id": "60b3ed55-7916-ba80-b354-95d08549c3e0", "created_at": "1948-07-31T17:25:03.593Z", "href": "string", "download_href": "string", "file_name": "string", "file_type": "string", "file_size": 2811 } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "ID Photos" ], "description": "Lists the ID photos that belong to an applicant.\n" }, "post": { "summary": "Upload ID photo", "responses": { "201": { "description": "The ID photo", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_type": { "type": "string" }, "file_size": { "type": "integer" } } }, "example": { "id": "7d43fdb0-c64b-4315-69e7-66ddddc0c926", "created_at": "1946-09-04T17:58:05.913Z", "href": "string", "download_href": "string", "file_name": "string", "file_type": "string", "file_size": 1600 } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "ID Photos" ], "description": "You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.\n" } }, "/id_photos/{id_photo_id}": { "get": { "summary": "Retrieve ID photo", "responses": { "200": { "description": "A ID photo", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "download_href": { "type": "string" }, "file_name": { "type": "string" }, "file_type": { "type": "string" }, "file_size": { "type": "integer" } } }, "example": { "id": "7d43fdb0-c64b-4315-69e7-66ddddc0c926", "created_at": "1946-09-04T17:58:05.913Z", "href": "string", "download_href": "string", "file_name": "string", "file_type": "string", "file_size": 1600 } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "ID Photos" ], "description": "Retrieves a single ID photo. Returns a ID photo object.\n" }, "parameters": [ { "name": "id_photo_id", "in": "path", "required": true, "description": "(Required) The ID photo's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/id_photos/{id_photo_id}/download": { "get": { "summary": "Download ID photo", "responses": { "200": { "description": "The ID photo's binary data." }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "ID Photos" ], "description": "ID photos are downloaded using this endpoint." }, "parameters": [ { "name": "id_photo_id", "in": "path", "required": true, "description": "(Required) The ID photo's unique identifier.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/qualified_electronic_signature/documents": { "get": { "summary": "Retrieves the signed document or application form", "parameters": [ { "name": "workflow_run_id", "in": "query", "description": "(Required) The unique identifier of the Workflow Run for which you want to retrieve the signed document.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" }, { "name": "file_id", "in": "query", "description": "(Required) The unique identifier of the file which you want to retrieve.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "The signed document PDF binary data." }, "302": { "description": "Found", "headers": { "Location": { "description": "Pre-signed URL to download the file.", "schema": { "type": "string" }, "example": "http://FQUbHAmvZ.nrMEhhpbnfvep8xYXKj5" } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Qualified Electronic Signature" ], "description": "Retrieves the signed document or application form depending on the file_id provided.\n" } }, "/advanced_electronic_signature/documents": { "get": { "summary": "Retrieves the signed document or signing transaction receipt", "parameters": [ { "name": "workflow_run_id", "in": "query", "description": "(Required) The unique identifier of the Workflow Run for which you want to retrieve the signed document.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" }, { "name": "id", "in": "query", "description": "(Required) The unique identifier of the file which you want to retrieve.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "The signed document PDF binary data." }, "302": { "description": "Found", "headers": { "Location": { "description": "Pre-signed URL to download the file.", "schema": { "type": "string" }, "example": "http://FQUbHAmvZ.nrMEhhpbnfvep8xYXKj5" } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Advanced Electronic Signature" ], "description": "Retrieves the signed document or signing transaction receipt depending on the id provided.\n" } }, "/simple_electronic_signature/documents": { "get": { "summary": "Retrieves the signed document or signing transaction receipt", "parameters": [ { "name": "workflow_run_id", "in": "query", "description": "(Required) The unique identifier of the Workflow Run for which you want to retrieve the signed document.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" }, { "name": "id", "in": "query", "description": "(Required) The unique identifier of the file which you want to retrieve.", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "The signed document PDF binary data." }, "302": { "description": "Found", "headers": { "Location": { "description": "Pre-signed URL to download the file.", "schema": { "type": "string" }, "example": "http://FQUbHAmvZ.nrMEhhpbnfvep8xYXKj5" } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Simple Electronic Signature" ], "description": "Retrieves the signed document or signing transaction receipt depending on the id provided.\n" } }, "/workflow_runs/{workflow_run_id}/timeline_file": { "post": { "summary": "Create Timeline File for Workflow Run", "responses": { "202": { "description": "A Timeline File reference.", "content": { "application/json": { "schema": { "type": "object", "properties": { "href": { "type": "string" }, "workflow_timeline_file_id": { "type": "string" } } }, "example": { "href": "string", "workflow_timeline_file_id": "468de2cf-5260-fe5e-df37-1b2ce67bc8d2" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Timeline Files" ], "description": "Triggers the generation of the Timeline File for the designated Workflow Run.\n" }, "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "(Required) The unique identifier of the Workflow Run.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id}": { "get": { "summary": "Retrieve Timeline File for Workflow Run", "responses": { "200": { "description": "The Timeline File PDF binary data." }, "302": { "description": "Found", "headers": { "Location": { "description": "Link to the Timeline File.", "schema": { "type": "string" }, "example": "http://FQUbHAmvZ.nrMEhhpbnfvep8xYXKj5" } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Timeline Files" ], "description": "Retrieves the Timeline File for the designated Workflow Run.\n" }, "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "(Required) The unique identifier of the Workflow Run.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" }, { "name": "timeline_file_id", "in": "path", "required": true, "description": "(Required) The unique identifier for the Timefile File.", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/passkeys/{username}": { "delete": { "summary": "Delete passkeys", "responses": { "204": { "description": "All passkeys deleted" }, "404": { "description": "Passkey not found" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Passkeys" ], "description": "Removes every passkey for the username.\n" }, "parameters": [ { "name": "username", "in": "path", "required": true, "description": "(Required) Username that owns the passkeys.", "schema": { "type": "string" }, "example": "string" } ], "get": { "summary": "List passkeys", "responses": { "200": { "description": "Passkeys belonging to the username", "content": { "application/json": { "schema": { "type": "object", "properties": { "passkeys": { "type": "array", "items": { "type": "object", "properties": { "application_domain": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "state": { "type": "string" }, "last_used_at": { "type": "string", "format": "date-time" } } } } } }, "example": { "passkeys": [ { "application_domain": "string", "created_at": "1969-06-21T06:22:26.919Z", "id": "string", "state": "ACTIVE", "last_used_at": "1984-11-30T14:40:55.868Z" }, { "application_domain": "string", "created_at": "2000-09-06T06:30:05.471Z", "id": "string", "state": "INACTIVE", "last_used_at": "2004-09-03T13:21:52.818Z" } ] } } } }, "404": { "description": "Passkey not found" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Passkeys" ], "description": "Returns every passkey registered under the supplied username.\n" } }, "/passkeys/{username}/{passkey_id}": { "delete": { "summary": "Delete passkey", "responses": { "204": { "description": "Passkey deleted" }, "404": { "description": "Passkey not found" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Passkeys" ], "description": "Deletes a passkey.\n" }, "parameters": [ { "name": "username", "in": "path", "required": true, "description": "(Required) Username that owns the passkey.", "schema": { "type": "string" }, "example": "string" }, { "name": "passkey_id", "in": "path", "required": true, "description": "(Required) Passkey ID.", "schema": { "type": "string" }, "example": "string" } ], "get": { "summary": "Retrieve passkey", "responses": { "200": { "description": "The requested passkey", "content": { "application/json": { "schema": { "type": "object", "properties": { "application_domain": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "state": { "type": "string" }, "last_used_at": { "type": "string", "format": "date-time" } } }, "example": { "application_domain": "string", "created_at": "2003-10-28T00:42:02.473Z", "id": "string", "state": "ACTIVE", "last_used_at": "1952-04-21T07:08:28.948Z" } } } }, "404": { "description": "Passkey not found" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Passkeys" ], "description": "Returns a passkey's details.\n" }, "put": { "summary": "Update passkey", "responses": { "200": { "description": "Passkey updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "application_domain": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "state": { "type": "string" }, "last_used_at": { "type": "string", "format": "date-time" } } }, "example": { "application_domain": "string", "created_at": "2003-10-28T00:42:02.473Z", "id": "string", "state": "ACTIVE", "last_used_at": "1952-04-21T07:08:28.948Z" } } } }, "400": { "description": "Invalid request body" }, "404": { "description": "Passkey not found" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Core Resources", "Passkeys" ], "description": "Updates a passkey's state.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string" } } }, "example": { "state": "INACTIVE" } } } } } }, "/ping": { "get": { "summary": "Ping", "responses": { "200": { "description": "Regional base URL is operational" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Ping" ], "description": "Run a health check on the Onfido API\n" } }, "/webhooks": { "get": { "summary": "List webhooks", "responses": { "200": { "description": "A list of webhooks", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } }, "environments": { "type": "array", "items": { "type": "string" } }, "payload_version": { "type": "integer" }, "oauth_enabled": { "type": "boolean" }, "oauth_server_url": { "type": "string" }, "oauth_server_client_id": { "type": "string" }, "oauth_server_client_secret": { "type": "string" }, "oauth_server_scope": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "token": { "type": "string" }, "href": { "type": "string" } } } } } }, "example": { "webhooks": [ { "id": "b0f823e1-1c24-8a05-a4c4-0f3a8901ae19", "enabled": false, "events": [ "workflow_run_evidence_folder.created", "report.completed" ], "environments": [ "string", "string" ], "payload_version": 8808, "oauth_enabled": false, "oauth_server_url": "string", "oauth_server_client_id": "string", "oauth_server_client_secret": "string", "oauth_server_scope": "string", "name": "string", "url": "string", "token": "string", "href": "string" }, { "id": "ca09e04e-6e86-dc29-e52a-049f52c260cb", "enabled": false, "events": [ "check.completed", "workflow_task.completed" ], "environments": [ "string", "string" ], "payload_version": 5573, "oauth_enabled": false, "oauth_server_url": "string", "oauth_server_client_id": "string", "oauth_server_client_secret": "string", "oauth_server_scope": "string", "name": "string", "url": "string", "token": "string", "href": "string" } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Webhooks" ], "description": "Lists all webhooks you've created.\n" }, "post": { "summary": "Register webhook", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } }, "environments": { "type": "array", "items": { "type": "string" } }, "payload_version": { "type": "integer" }, "oauth_enabled": { "type": "boolean" }, "oauth_server_url": { "type": "string" }, "oauth_server_client_id": { "type": "string" }, "oauth_server_client_secret": { "type": "string" }, "oauth_server_scope": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "token": { "type": "string" }, "href": { "type": "string" } } }, "example": { "id": "7fec5cd4-f568-21dd-4695-4a96807e85fd", "enabled": true, "events": [ "check.reopened", "report.completed" ], "environments": [ "string", "string" ], "payload_version": 5127, "oauth_enabled": true, "oauth_server_url": "string", "oauth_server_client_id": "string", "oauth_server_client_secret": "string", "oauth_server_scope": "string", "name": "string", "url": "string", "token": "string", "href": "string" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Webhooks" ], "description": "Registers a webhook. Returns a webhook object.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } }, "environments": { "type": "array", "items": { "type": "string" } }, "payload_version": { "type": "integer" }, "oauth_enabled": { "type": "boolean" }, "oauth_server_url": { "type": "string" }, "oauth_server_client_id": { "type": "string" }, "oauth_server_client_secret": { "type": "string" }, "oauth_server_scope": { "type": "string" }, "name": { "type": "string" } } }, "example": { "url": "string", "enabled": true, "events": [ "workflow_timeline_file.created", "report.completed" ], "environments": [ "string", "string" ], "payload_version": 5549, "oauth_enabled": true, "oauth_server_url": "string", "oauth_server_client_id": "string", "oauth_server_client_secret": "string", "oauth_server_scope": "string", "name": "string" } } } } } }, "/webhooks/{webhook_id}": { "delete": { "summary": "Delete a webhook", "responses": { "204": { "description": "Webhook deleted" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Webhooks" ], "description": "Deletes a webhook.\n" }, "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ], "get": { "summary": "Retrieve a Webhook", "responses": { "200": { "description": "Webhook object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } }, "environments": { "type": "array", "items": { "type": "string" } }, "payload_version": { "type": "integer" }, "oauth_enabled": { "type": "boolean" }, "oauth_server_url": { "type": "string" }, "oauth_server_client_id": { "type": "string" }, "oauth_server_client_secret": { "type": "string" }, "oauth_server_scope": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "token": { "type": "string" }, "href": { "type": "string" } } }, "example": { "id": "7fec5cd4-f568-21dd-4695-4a96807e85fd", "enabled": true, "events": [ "check.reopened", "report.completed" ], "environments": [ "string", "string" ], "payload_version": 5127, "oauth_enabled": true, "oauth_server_url": "string", "oauth_server_client_id": "string", "oauth_server_client_secret": "string", "oauth_server_scope": "string", "name": "string", "url": "string", "token": "string", "href": "string" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Webhooks" ], "description": "Retrieves a single webhook. Returns a webhook object.\n" }, "put": { "summary": "Edit a webhook", "responses": { "200": { "description": "Webhook Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } }, "environments": { "type": "array", "items": { "type": "string" } }, "payload_version": { "type": "integer" }, "oauth_enabled": { "type": "boolean" }, "oauth_server_url": { "type": "string" }, "oauth_server_client_id": { "type": "string" }, "oauth_server_client_secret": { "type": "string" }, "oauth_server_scope": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "token": { "type": "string" }, "href": { "type": "string" } } }, "example": { "id": "7fec5cd4-f568-21dd-4695-4a96807e85fd", "enabled": true, "events": [ "check.reopened", "report.completed" ], "environments": [ "string", "string" ], "payload_version": 5127, "oauth_enabled": true, "oauth_server_url": "string", "oauth_server_client_id": "string", "oauth_server_client_secret": "string", "oauth_server_scope": "string", "name": "string", "url": "string", "token": "string", "href": "string" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Webhooks" ], "description": "Edits a webhook. Returns the updated webhook object.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } }, "environments": { "type": "array", "items": { "type": "string" } }, "payload_version": { "type": "integer" }, "oauth_enabled": { "type": "boolean" }, "oauth_server_url": { "type": "string" }, "oauth_server_client_id": { "type": "string" }, "oauth_server_client_secret": { "type": "string" }, "oauth_server_scope": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" } } }, "example": { "enabled": false, "events": [ "check.started", "check.reopened" ], "environments": [ "string", "string" ], "payload_version": 7518, "oauth_enabled": true, "oauth_server_url": "string", "oauth_server_client_id": "string", "oauth_server_client_secret": "string", "oauth_server_scope": "string", "name": "string", "url": "string" } } } } } }, "/webhooks/resend": { "post": { "summary": "Resends webhooks", "responses": { "204": { "description": "Webhooks are resent for the respective checks" }, "422": { "description": "Request was received but it could not be processed" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Webhooks" ], "description": "Resends events to all webhooks registered with a matching environment in your account.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "event": { "type": "string" }, "resource_id": { "type": "string" } } } } } }, "example": { "data": [ { "event": "check.completed", "resource_id": "28c0d58b-a8f9-e8ef-5f64-73e1e3d1c93f" }, { "event": "check.completed", "resource_id": "ccac926f-b154-7afb-3de9-9dbe515f6ff9" } ] } } } } } }, "/addresses/pick": { "get": { "summary": "Address Picker", "parameters": [ { "name": "postcode", "in": "query", "description": "(Required) ", "schema": { "type": "string" }, "example": "string" } ], "responses": { "200": { "description": "A list of addresses", "content": { "application/json": { "schema": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "postcode": { "type": "string" }, "flat_number": { "type": "string" }, "building_number": { "type": "string" }, "building_name": { "type": "string" }, "street": { "type": "string" }, "sub_street": { "type": "string" }, "town": { "type": "string" }, "state": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string", "format": "uri" }, "line3": { "type": "string" } } } } } }, "example": { "addresses": [ { "country": "CUB", "postcode": "string", "flat_number": "string", "building_number": "string", "building_name": "string", "street": "string", "sub_street": "string", "town": "string", "state": "string", "line1": "S/", "line2": "utt:B9IJI", "line3": "t" }, { "country": "COD", "postcode": "string", "flat_number": "string", "building_number": "string", "building_name": "string", "street": "string", "sub_street": "string", "town": "string", "state": "string", "line1": "u3'VVw2TAg", "line2": "X.a/+w}7", "line3": "ND;vN3v" } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Address Picker" ], "description": "Search for addresses by postcode\n" } }, "/sdk_token": { "post": { "summary": "Generate a SDK token", "responses": { "200": { "description": "Generated", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } } }, "example": { "token": "string" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Generate SDK Token" ], "description": "Generates an SDK token. Returns a token object containing the SDK token.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "referrer": { "type": "string" }, "application_id": { "type": "string" }, "cross_device_url": { "type": "string" } } }, "example": { "applicant_id": "6950e65e-90d9-64e4-22c9-ba5a4392cc84", "referrer": "string", "application_id": "string", "cross_device_url": "string" } } } } } }, "/repeat_attempts/{report_id}": { "get": { "summary": "Retrieve repeat attempts", "responses": { "200": { "description": "Repeat attempts object", "content": { "application/json": { "schema": { "type": "object", "properties": { "repeat_attempts": { "type": "array", "items": { "type": "object", "properties": { "report_id": { "type": "string" }, "applicant_id": { "type": "string" }, "date_of_birth": { "type": "string" }, "names": { "type": "string" }, "result": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time" } } } }, "report_id": { "type": "string" }, "attempts_count": { "type": "integer" }, "attempts_clear_rate": { "type": "number" }, "unique_mismatches_count": { "type": "integer" } } }, "example": { "repeat_attempts": [ { "report_id": "4d0e4f21-887d-e264-a6bb-e221438ff532", "applicant_id": "9fa504e4-335c-6adb-4d87-e80e40c76da9", "date_of_birth": "mismatch", "names": "mismatch", "result": "clear", "created_at": "1952-06-05T17:13:42.359Z", "completed_at": "1991-08-23T12:59:32.324Z" }, { "report_id": "e51ddb56-62fc-884a-1e32-86fe074a15b6", "applicant_id": "b69b2ab4-e9ae-f3d8-5e22-3faeb09d0f91", "date_of_birth": "mismatch", "names": "match", "result": "clear", "created_at": "2025-09-14T21:32:49.523Z", "completed_at": "2017-08-06T23:45:28.390Z" } ], "report_id": "8919b200-c8e9-19cc-f412-6f421dc09edb", "attempts_count": 6829, "attempts_clear_rate": 0.25000732486386923, "unique_mismatches_count": 7004 } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Repeat attempts" ], "description": "Returns all repeat attempts for a given Document report\n" }, "parameters": [ { "name": "report_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/extractions": { "post": { "summary": "Autofill", "responses": { "200": { "description": "Extraction result", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_id": { "type": "string" }, "document_classification": { "type": "object", "properties": { "issuing_country": { "type": "string" }, "document_type": { "type": "string" }, "issuing_state": { "type": "string" }, "subtype": { "type": "string" }, "version": { "type": "string" } } }, "extracted_data": { "type": "object", "properties": { "document_number": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "spouse_name": { "type": "string" }, "widow_name": { "type": "string" }, "alias_name": { "type": "string" }, "gender": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "date_of_expiry": { "type": "string", "format": "date" }, "expiry_date": { "type": "string", "format": "date" }, "nationality": { "type": "string" }, "mrz_line_1": { "type": "string" }, "mrz_line_2": { "type": "string" }, "mrz_line_3": { "type": "string" }, "address_1": { "type": "string" }, "address_2": { "type": "string" }, "address_3": { "type": "string" }, "address_4": { "type": "string" }, "address_5": { "type": "string" }, "issuing_authority": { "type": "string" }, "issuing_country": { "type": "string" }, "document_type": { "type": "string" }, "place_of_birth": { "type": "string" }, "issuing_state": { "type": "string" }, "issuing_date": { "type": "string", "format": "date" }, "personal_number": { "type": "string" } } } } }, "example": { "document_id": "e98644af-ede9-e628-6be3-f234a268b9e3", "document_classification": { "issuing_country": "EST", "document_type": "right_to_work_share_code_result", "issuing_state": "string", "subtype": "spe", "version": "string" }, "extracted_data": { "document_number": "string", "first_name": "string", "last_name": "string", "full_name": "string", "spouse_name": "string", "widow_name": "string", "alias_name": "string", "gender": "Female", "date_of_birth": "1981-10-20", "date_of_expiry": "2014-06-13", "expiry_date": "1966-12-02", "nationality": "WPU", "mrz_line_1": "string", "mrz_line_2": "string", "mrz_line_3": "string", "address_1": "string", "address_2": "string", "address_3": "string", "address_4": "string", "address_5": "string", "issuing_authority": "string", "issuing_country": "PYF", "document_type": "immigration_status_document", "place_of_birth": "string", "issuing_state": "string", "issuing_date": "2000-01-19", "personal_number": "string" } } } } }, "default": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_id": { "type": "string" }, "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } } }, "example": { "document_id": "string", "error": { "type": "string", "message": "string" } } } } } }, "tags": [ "Other Endpoints", "Autofill" ], "description": "Extract information from a document\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "document_id": { "type": "string" } } }, "example": { "document_id": "85c812c1-8783-ae11-bb3e-7e989dcb1c1c" } } } } } }, "/results_feedback": { "post": { "summary": "Fraud reporting (ALPHA)", "responses": { "200": { "description": "Created feedback", "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_result": { "type": "string" }, "check_id": { "type": "string" }, "report_id": { "type": "string" }, "feedback_notes": { "type": "string" } } }, "example": { "expected_result": "clear", "check_id": "8253a364-e17e-a826-5e00-32f22b332785", "report_id": "4e194661-faf7-f1fb-afe3-5fc804d99e55", "feedback_notes": "string" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Fraud reporting (ALPHA)" ], "description": "Create Feedback on checks and reports\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_result": { "type": "string" }, "check_id": { "type": "string" }, "report_id": { "type": "string" }, "feedback_notes": { "type": "string" } } }, "example": { "expected_result": "clear", "check_id": "8253a364-e17e-a826-5e00-32f22b332785", "report_id": "4e194661-faf7-f1fb-afe3-5fc804d99e55", "feedback_notes": "string" } } } } } }, "/checks": { "get": { "summary": "Retrieve Checks", "parameters": [ { "name": "applicant_id", "in": "query", "description": "(Required) ", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "An array of checks", "content": { "application/json": { "schema": { "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "id": { "type": "string" }, "webhook_ids": { "type": "array", "items": { "type": "string" } }, "applicant_provides_data": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "redirect_uri": { "type": "string" }, "privacy_notices_read_consent_given": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "string" }, "form_uri": { "type": "string" }, "results_uri": { "type": "string" }, "report_ids": { "type": "array", "items": { "type": "string" } }, "sandbox": { "type": "boolean" }, "paused": { "type": "boolean" }, "version": { "type": "string" } } } } } }, "example": { "checks": [ { "applicant_id": "31238c47-c2f4-4cb5-43b3-0eb1957d1102", "id": "d14b37b5-a4c9-7c5a-89bd-492a15e9f83e", "webhook_ids": [ "string", "string" ], "applicant_provides_data": true, "tags": [ "string", "string" ], "redirect_uri": "string", "privacy_notices_read_consent_given": true, "created_at": "2005-04-16T21:14:54.351Z", "href": "string", "status": "awaiting_applicant", "result": "consider", "form_uri": "string", "results_uri": "string", "report_ids": [ "bde40e5a-bfaa-71df-467a-0f56bab91421", "99c56f92-5c65-fc20-10c0-168ece27f3fc" ], "sandbox": false, "paused": false, "version": "3.6" }, { "applicant_id": "b2614479-d11e-1a83-ec92-59815bec6714", "id": "d41beb8d-fa7b-b2d6-1311-ee4ee7bcdbc1", "webhook_ids": [ "string", "string" ], "applicant_provides_data": true, "tags": [ "string", "string" ], "redirect_uri": "string", "privacy_notices_read_consent_given": true, "created_at": "1965-02-04T19:41:23.933Z", "href": "string", "status": "reopened", "result": "consider", "form_uri": "string", "results_uri": "string", "report_ids": [ "7735c0c3-6aed-95a2-0b99-38643cd86bba", "7865609d-77f6-0831-2379-f4a249868135" ], "sandbox": false, "paused": false, "version": "3.6" } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Checks" ], "description": "Retrieves a single check. Returns a check object.\n" }, "post": { "summary": "Create a check", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "id": { "type": "string" }, "webhook_ids": { "type": "array", "items": { "type": "string" } }, "applicant_provides_data": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "redirect_uri": { "type": "string" }, "privacy_notices_read_consent_given": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "string" }, "form_uri": { "type": "string" }, "results_uri": { "type": "string" }, "report_ids": { "type": "array", "items": { "type": "string" } }, "sandbox": { "type": "boolean" }, "paused": { "type": "boolean" }, "version": { "type": "string" } } }, "example": { "applicant_id": "c57f58f0-9cba-355b-8fb9-3cfe2379be7d", "id": "55ae8606-195c-bbec-944d-ae114a473093", "webhook_ids": [ "string", "string" ], "applicant_provides_data": true, "tags": [ "string", "string" ], "redirect_uri": "string", "privacy_notices_read_consent_given": false, "created_at": "1972-09-26T15:27:59.524Z", "href": "string", "status": "withdrawn", "result": "clear", "form_uri": "string", "results_uri": "string", "report_ids": [ "7996f767-518e-a127-de73-59a645c72f89", "f9353849-8dd9-7ede-e0bc-3e9e0941d744" ], "sandbox": true, "paused": true, "version": "3.6" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Checks" ], "description": "Initiates a check for an applicant, which can contain one or more reports. Returns a check object.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "report_names": { "type": "array", "items": { "type": "string" } }, "webhook_ids": { "type": "array", "items": { "type": "string" } }, "applicant_provides_data": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "redirect_uri": { "type": "string" }, "privacy_notices_read_consent_given": { "type": "boolean" }, "document_ids": { "type": "array", "items": { "type": "string" } }, "asynchronous": { "type": "boolean" }, "suppress_form_emails": { "type": "boolean" }, "sub_result": { "type": "string" }, "consider": { "type": "array", "items": { "type": "string" } }, "us_driving_licence": { "type": "object", "properties": { "id_number": { "type": "string" }, "issue_state": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "city": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "document_category": { "type": "string" }, "expiration_date": { "type": "string", "format": "date" }, "eye_color_code": { "type": "string" }, "first_name": { "type": "string" }, "issue_date": { "type": "string", "format": "date" }, "last_name": { "type": "string" }, "middle_name": { "type": "string" }, "name_suffix": { "type": "string" }, "postal_code": { "type": "string" }, "state": { "type": "string" }, "weight_measure": { "type": "integer" } } }, "report_configuration": { "type": "object", "properties": { "facial_similarity_photo": { "type": "object", "properties": { "use_case": { "type": "string" } } }, "facial_similarity_photo_fully_auto": { "type": "object", "properties": { "use_case": { "type": "string" } } }, "facial_similarity_video": { "type": "object", "properties": { "use_case": { "type": "string" } } }, "facial_similarity_motion": { "type": "object", "properties": { "use_case": { "type": "string" } } } } } } }, "example": { "applicant_id": "204fadf6-2609-c6b1-f318-fb664575fad8", "report_names": [ "device_intelligence", "proof_of_address" ], "webhook_ids": [ "string", "string" ], "applicant_provides_data": false, "tags": [ "string", "string" ], "redirect_uri": "string", "privacy_notices_read_consent_given": true, "document_ids": [ "1a2f7710-1c2d-e6a7-20dd-b4b445a55802", "f0fee87d-d7ae-975f-5ef1-68c2305f219b" ], "asynchronous": true, "suppress_form_emails": true, "sub_result": "string", "consider": [ "facial_similarity_photo_fully_auto", "watchlist_standard" ], "us_driving_licence": { "id_number": "string", "issue_state": "NN", "address_line_1": "string", "address_line_2": "string", "city": "string", "date_of_birth": "2006-04-29", "document_category": "id card", "expiration_date": "1958-05-27", "eye_color_code": "BRO", "first_name": "string", "issue_date": "1982-12-16", "last_name": "string", "middle_name": "string", "name_suffix": "string", "postal_code": "string", "state": "CA", "weight_measure": 417 }, "report_configuration": { "facial_similarity_photo": { "use_case": "reverification" }, "facial_similarity_photo_fully_auto": { "use_case": "reverification" }, "facial_similarity_video": { "use_case": "onboarding" }, "facial_similarity_motion": { "use_case": "reverification" } } } } } } } }, "/checks/{check_id}": { "get": { "summary": "Retrieve a Check", "responses": { "200": { "description": "Check object", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "type": "string" }, "id": { "type": "string" }, "webhook_ids": { "type": "array", "items": { "type": "string" } }, "applicant_provides_data": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "redirect_uri": { "type": "string" }, "privacy_notices_read_consent_given": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "string" }, "form_uri": { "type": "string" }, "results_uri": { "type": "string" }, "report_ids": { "type": "array", "items": { "type": "string" } }, "sandbox": { "type": "boolean" }, "paused": { "type": "boolean" }, "version": { "type": "string" } } }, "example": { "applicant_id": "c57f58f0-9cba-355b-8fb9-3cfe2379be7d", "id": "55ae8606-195c-bbec-944d-ae114a473093", "webhook_ids": [ "string", "string" ], "applicant_provides_data": true, "tags": [ "string", "string" ], "redirect_uri": "string", "privacy_notices_read_consent_given": false, "created_at": "1972-09-26T15:27:59.524Z", "href": "string", "status": "withdrawn", "result": "clear", "form_uri": "string", "results_uri": "string", "report_ids": [ "7996f767-518e-a127-de73-59a645c72f89", "f9353849-8dd9-7ede-e0bc-3e9e0941d744" ], "sandbox": true, "paused": true, "version": "3.6" } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Checks" ], "description": "Retrieves a single check. Returns a check object.\n" }, "parameters": [ { "name": "check_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/checks/{check_id}/resume": { "post": { "summary": "Resume a Check", "responses": { "204": { "description": "No Content" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Checks" ], "description": "Resumes a paused check.\n" }, "parameters": [ { "name": "check_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/checks/{check_id}/download": { "get": { "summary": "Download check", "responses": { "200": { "description": "The check PDF binary data" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Checks" ], "description": "Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.\n" }, "parameters": [ { "name": "check_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/reports": { "get": { "summary": "List reports", "parameters": [ { "name": "check_id", "in": "query", "description": "(Required) ", "schema": { "type": "string" }, "example": "{{authorization_secret_-_uuid}}" } ], "responses": { "200": { "description": "List of Reports", "content": { "application/json": { "schema": { "type": "object", "properties": { "reports": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "string" }, "sub_result": { "type": "string" }, "check_id": { "type": "string" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } } }, "breakdown": { "type": "object", "properties": { "data_comparison": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "issuing_country": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "gender": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "date_of_expiry": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "last_name": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_type": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_numbers": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "first_name": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "date_of_birth": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "data_validation": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "gender": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "date_of_birth": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_numbers": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_expiration": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "expiry_date": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "mrz": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "barcode": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "image_integrity": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "image_quality": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object", "properties": { "dark_photo": { "type": "string" }, "glare_on_photo": { "type": "string" }, "blurred_photo": { "type": "string" }, "covered_photo": { "type": "string" }, "other_photo_issue": { "type": "string" }, "damaged_document": { "type": "string" }, "incorrect_side": { "type": "string" }, "cut_off_document": { "type": "string" }, "no_document_in_image": { "type": "string" }, "two_documents_uploaded": { "type": "string" } } } } }, "supported_document": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "colour_picture": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "conclusive_document_quality": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object", "properties": { "obscured_data_points": { "type": "string" }, "obscured_security_features": { "type": "string" }, "abnormal_document_features": { "type": "string" }, "watermarks_digital_text_overlay": { "type": "string" }, "corner_removed": { "type": "string" }, "punctured_document": { "type": "string" }, "missing_back": { "type": "string" }, "digital_document": { "type": "string" } } } } } } } } }, "visual_authenticity": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "fonts": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "picture_face_integrity": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "template": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "security_features": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "original_document_present": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object", "properties": { "photo_of_screen": { "type": "string" }, "screenshot": { "type": "string" }, "document_on_printed_paper": { "type": "string" }, "scan": { "type": "string" } } } } }, "digital_tampering": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "other": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "face_detection": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "data_consistency": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "date_of_expiry": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_numbers": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "issuing_country": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_type": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "date_of_birth": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "gender": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "first_name": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "nationality": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "last_name": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "multiple_data_sources_present": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "police_record": { "type": "object", "properties": { "result": { "type": "string" } } }, "compromised_document": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "document_database": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "repeat_attempts": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "age_validation": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "minimum_accepted_age": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "issuing_authority": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "nfc_active_authentication": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "nfc_passive_authentication": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } } } }, "properties": { "type": "object", "properties": { "date_of_birth": { "type": "string", "format": "date" }, "date_of_expiry": { "type": "string", "format": "date" }, "personal_number": { "type": "string" }, "document_numbers": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "type": { "type": "string" } } } }, "document_type": { "type": "string" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "gender": { "type": "string" }, "issuing_country": { "type": "string" }, "nationality": { "type": "string" }, "issuing_state": { "type": "string" }, "issuing_date": { "type": "string", "format": "date" }, "valid_from": { "type": "string", "format": "date" }, "categorisation": { "type": "string" }, "mrz_line1": { "type": "string" }, "mrz_line2": { "type": "string" }, "mrz_line3": { "type": "string" }, "address": { "type": "string" }, "place_of_birth": { "type": "string" }, "spouse_name": { "type": "string" }, "widow_name": { "type": "string" }, "alias_name": { "type": "string" }, "issuing_authority": { "type": "string" }, "remarks": { "type": "string" }, "civil_state": { "type": "string" }, "expatriation": { "type": "string" }, "father_name": { "type": "string" }, "mother_name": { "type": "string" }, "religion": { "type": "string" }, "type_of_permit": { "type": "string" }, "version_number": { "type": "string" }, "document_subtype": { "type": "string" }, "profession": { "type": "string" }, "security_document_number": { "type": "string" }, "tax_number": { "type": "string" }, "nist_identity_evidence_strength": { "type": "string" }, "has_issuance_confirmation": { "type": "string" }, "real_id_compliance": { "type": "boolean" }, "security_tier": { "type": "string" }, "address_lines": { "type": "object", "properties": { "street_address": { "type": "string" }, "state": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "country_code": { "type": "string" } } }, "barcode": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "document_type": { "type": "string" }, "date_of_expiry": { "type": "string", "format": "date" }, "date_of_birth": { "type": "string", "format": "date" }, "issuing_date": { "type": "string", "format": "date" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "address_line_3": { "type": "string" }, "address_line_4": { "type": "string" }, "address_line_5": { "type": "string" }, "issuing_state": { "type": "string" }, "class": { "type": "string" }, "gender": { "type": "string" }, "issuing_country": { "type": "string" }, "document_number": { "type": "string" }, "real_id_classification": { "type": "string" } } } }, "nfc": { "type": "object", "properties": { "document_type": { "type": "string" }, "issuing_country": { "type": "string" }, "full_name": { "type": "string" }, "document_number": { "type": "string" }, "nationality": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "gender": { "type": "string" }, "date_of_expiry": { "type": "string", "format": "date" }, "personal_number": { "type": "string" }, "place_of_birth": { "type": "string" }, "address": { "type": "string" }, "issuing_date": { "type": "string", "format": "date" }, "issuing_authority": { "type": "string" } } }, "document_classification": { "type": "object", "properties": { "issuing_country": { "type": "string" }, "document_type": { "type": "string" }, "issuing_state": { "type": "string" } } }, "extracted_data": { "type": "object", "properties": { "document_number": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "date_of_expiry": { "type": "string", "format": "date" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "middle_name": { "type": "string" }, "full_name": { "type": "string" }, "spouse_name": { "type": "string" }, "widow_name": { "type": "string" }, "alias_name": { "type": "string" }, "gender": { "type": "string" }, "mrz_line1": { "type": "string" }, "mrz_line2": { "type": "string" }, "mrz_line3": { "type": "string" }, "nationality": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "address_line_3": { "type": "string" }, "address_line_4": { "type": "string" }, "address_line_5": { "type": "string" }, "issuing_authority": { "type": "string" } } } } } } } } } }, "example": { "reports": [ { "id": "c1336dbc-f21a-0657-39b4-a6a00656aa8b", "name": "document_with_address_information", "created_at": "1955-04-22T13:48:53.416Z", "href": "string", "status": "complete", "result": "consider", "sub_result": "suspected", "check_id": "2dc7e237-a7bf-b0c4-82bb-4cdb73b7722a", "documents": [ { "id": "97df5345-363f-69c0-b30a-92933124088c" }, { "id": "783855c3-0bc5-4e8b-daaf-d015c884963e" } ], "breakdown": { "data_comparison": { "result": "string", "breakdown": { "issuing_country": { "result": "string", "properties": {} }, "gender": { "result": "string", "properties": {} }, "date_of_expiry": { "result": "string", "properties": {} }, "last_name": { "result": "string", "properties": {} }, "document_type": { "result": "string", "properties": {} }, "document_numbers": { "result": "string", "properties": {} }, "first_name": { "result": "string", "properties": {} }, "date_of_birth": { "result": "string", "properties": {} } } }, "data_validation": { "result": "string", "breakdown": { "gender": { "result": "string", "properties": {} }, "date_of_birth": { "result": "string", "properties": {} }, "document_numbers": { "result": "string", "properties": {} }, "document_expiration": { "result": "string", "properties": {} }, "expiry_date": { "result": "string", "properties": {} }, "mrz": { "result": "string", "properties": {} }, "barcode": { "result": "string", "properties": {} } } }, "image_integrity": { "result": "string", "breakdown": { "image_quality": { "result": "string", "properties": { "dark_photo": "string", "glare_on_photo": "string", "blurred_photo": "string", "covered_photo": "string", "other_photo_issue": "string", "damaged_document": "string", "incorrect_side": "string", "cut_off_document": "string", "no_document_in_image": "string", "two_documents_uploaded": "string" } }, "supported_document": { "result": "string", "properties": {} }, "colour_picture": { "result": "string", "properties": {} }, "conclusive_document_quality": { "result": "string", "properties": { "obscured_data_points": "string", "obscured_security_features": "string", "abnormal_document_features": "string", "watermarks_digital_text_overlay": "string", "corner_removed": "string", "punctured_document": "string", "missing_back": "string", "digital_document": "string" } } } }, "visual_authenticity": { "result": "string", "breakdown": { "fonts": { "result": "string", "properties": {} }, "picture_face_integrity": { "result": "string", "properties": {} }, "template": { "result": "string", "properties": {} }, "security_features": { "result": "string", "properties": {} }, "original_document_present": { "result": "string", "properties": { "photo_of_screen": "string", "screenshot": "string", "document_on_printed_paper": "string", "scan": "string" } }, "digital_tampering": { "result": "string", "properties": {} }, "other": { "result": "string", "properties": {} }, "face_detection": { "result": "string", "properties": {} } } }, "data_consistency": { "result": "string", "breakdown": { "date_of_expiry": { "result": "string", "properties": {} }, "document_numbers": { "result": "string", "properties": {} }, "issuing_country": { "result": "string", "properties": {} }, "document_type": { "result": "string", "properties": {} }, "date_of_birth": { "result": "string", "properties": {} }, "gender": { "result": "string", "properties": {} }, "first_name": { "result": "string", "properties": {} }, "nationality": { "result": "string", "properties": {} }, "last_name": { "result": "string", "properties": {} }, "multiple_data_sources_present": { "result": "string", "properties": {} } } }, "police_record": { "result": "string" }, "compromised_document": { "result": "string", "breakdown": { "document_database": { "result": "string", "properties": {} }, "repeat_attempts": { "result": "string", "properties": {} } } }, "age_validation": { "result": "string", "breakdown": { "minimum_accepted_age": { "result": "string", "properties": {} } } }, "issuing_authority": { "result": "string", "breakdown": { "nfc_active_authentication": { "result": "string", "properties": {} }, "nfc_passive_authentication": { "result": "string", "properties": {} } } } }, "properties": { "date_of_birth": "1990-02-09", "date_of_expiry": "1999-06-06", "personal_number": "string", "document_numbers": [ { "value": "string", "type": "string" }, { "value": "string", "type": "string" } ], "document_type": "string", "first_name": "string", "middle_name": "string", "last_name": "string", "gender": "string", "issuing_country": "string", "nationality": "string", "issuing_state": "string", "issuing_date": "1997-01-03", "valid_from": "2024-10-04", "categorisation": "string", "mrz_line1": "string", "mrz_line2": "string", "mrz_line3": "string", "address": "string", "place_of_birth": "string", "spouse_name": "string", "widow_name": "string", "alias_name": "string", "issuing_authority": "string", "remarks": "string", "civil_state": "string", "expatriation": "string", "father_name": "string", "mother_name": "string", "religion": "string", "type_of_permit": "string", "version_number": "string", "document_subtype": "string", "profession": "string", "security_document_number": "string", "tax_number": "string", "nist_identity_evidence_strength": "unspecified_identity_evidence_strength", "has_issuance_confirmation": "true", "real_id_compliance": false, "security_tier": "unspecified_security_tier", "address_lines": { "street_address": "string", "state": "string", "postal_code": "string", "country": "string", "city": "string", "country_code": "string" }, "barcode": [ { "first_name": "string", "middle_name": "string", "last_name": "string", "document_type": "string", "date_of_expiry": "1972-03-23", "date_of_birth": "2009-06-20", "issuing_date": "2021-08-20", "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "address_line_4": "string", "address_line_5": "string", "issuing_state": "string", "class": "string", "gender": "string", "issuing_country": "string", "document_number": "string", "real_id_classification": "string" }, { "first_name": "string", "middle_name": "string", "last_name": "string", "document_type": "string", "date_of_expiry": "2024-01-13", "date_of_birth": "2007-03-28", "issuing_date": "1985-12-03", "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "address_line_4": "string", "address_line_5": "string", "issuing_state": "string", "class": "string", "gender": "string", "issuing_country": "string", "document_number": "string", "real_id_classification": "string" } ], "nfc": { "document_type": "string", "issuing_country": "string", "full_name": "string", "document_number": "string", "nationality": "string", "date_of_birth": "1960-07-15", "gender": "string", "date_of_expiry": "1981-11-13", "personal_number": "string", "place_of_birth": "string", "address": "string", "issuing_date": "2006-12-27", "issuing_authority": "string" }, "document_classification": { "issuing_country": "string", "document_type": "string", "issuing_state": "string" }, "extracted_data": { "document_number": "string", "date_of_birth": "2002-08-12", "date_of_expiry": "2012-01-14", "first_name": "string", "last_name": "string", "middle_name": "string", "full_name": "string", "spouse_name": "string", "widow_name": "string", "alias_name": "string", "gender": "string", "mrz_line1": "string", "mrz_line2": "string", "mrz_line3": "string", "nationality": "string", "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "address_line_4": "string", "address_line_5": "string", "issuing_authority": "string" } } }, { "id": "d688762e-8813-13ed-9334-c96eeacb53c3", "name": "document", "created_at": "1983-02-17T17:35:33.611Z", "href": "string", "status": "withdrawn", "result": "unidentified", "sub_result": "rejected", "check_id": "e85551dd-cde2-f5a3-4545-74125f509aa5", "documents": [ { "id": "16a2e95e-6254-452e-4d90-dce3b4a7c2f4" }, { "id": "8998b17b-9594-516e-340f-cc5f16cd6adc" } ], "breakdown": { "data_comparison": { "result": "string", "breakdown": { "issuing_country": { "result": "string", "properties": {} }, "gender": { "result": "string", "properties": {} }, "date_of_expiry": { "result": "string", "properties": {} }, "last_name": { "result": "string", "properties": {} }, "document_type": { "result": "string", "properties": {} }, "document_numbers": { "result": "string", "properties": {} }, "first_name": { "result": "string", "properties": {} }, "date_of_birth": { "result": "string", "properties": {} } } }, "data_validation": { "result": "string", "breakdown": { "gender": { "result": "string", "properties": {} }, "date_of_birth": { "result": "string", "properties": {} }, "document_numbers": { "result": "string", "properties": {} }, "document_expiration": { "result": "string", "properties": {} }, "expiry_date": { "result": "string", "properties": {} }, "mrz": { "result": "string", "properties": {} }, "barcode": { "result": "string", "properties": {} } } }, "image_integrity": { "result": "string", "breakdown": { "image_quality": { "result": "string", "properties": { "dark_photo": "string", "glare_on_photo": "string", "blurred_photo": "string", "covered_photo": "string", "other_photo_issue": "string", "damaged_document": "string", "incorrect_side": "string", "cut_off_document": "string", "no_document_in_image": "string", "two_documents_uploaded": "string" } }, "supported_document": { "result": "string", "properties": {} }, "colour_picture": { "result": "string", "properties": {} }, "conclusive_document_quality": { "result": "string", "properties": { "obscured_data_points": "string", "obscured_security_features": "string", "abnormal_document_features": "string", "watermarks_digital_text_overlay": "string", "corner_removed": "string", "punctured_document": "string", "missing_back": "string", "digital_document": "string" } } } }, "visual_authenticity": { "result": "string", "breakdown": { "fonts": { "result": "string", "properties": {} }, "picture_face_integrity": { "result": "string", "properties": {} }, "template": { "result": "string", "properties": {} }, "security_features": { "result": "string", "properties": {} }, "original_document_present": { "result": "string", "properties": { "photo_of_screen": "string", "screenshot": "string", "document_on_printed_paper": "string", "scan": "string" } }, "digital_tampering": { "result": "string", "properties": {} }, "other": { "result": "string", "properties": {} }, "face_detection": { "result": "string", "properties": {} } } }, "data_consistency": { "result": "string", "breakdown": { "date_of_expiry": { "result": "string", "properties": {} }, "document_numbers": { "result": "string", "properties": {} }, "issuing_country": { "result": "string", "properties": {} }, "document_type": { "result": "string", "properties": {} }, "date_of_birth": { "result": "string", "properties": {} }, "gender": { "result": "string", "properties": {} }, "first_name": { "result": "string", "properties": {} }, "nationality": { "result": "string", "properties": {} }, "last_name": { "result": "string", "properties": {} }, "multiple_data_sources_present": { "result": "string", "properties": {} } } }, "police_record": { "result": "string" }, "compromised_document": { "result": "string", "breakdown": { "document_database": { "result": "string", "properties": {} }, "repeat_attempts": { "result": "string", "properties": {} } } }, "age_validation": { "result": "string", "breakdown": { "minimum_accepted_age": { "result": "string", "properties": {} } } }, "issuing_authority": { "result": "string", "breakdown": { "nfc_active_authentication": { "result": "string", "properties": {} }, "nfc_passive_authentication": { "result": "string", "properties": {} } } } }, "properties": { "date_of_birth": "1967-10-15", "date_of_expiry": "1951-08-31", "personal_number": "string", "document_numbers": [ { "value": "string", "type": "string" }, { "value": "string", "type": "string" } ], "document_type": "string", "first_name": "string", "middle_name": "string", "last_name": "string", "gender": "string", "issuing_country": "string", "nationality": "string", "issuing_state": "string", "issuing_date": "1988-02-01", "valid_from": "2013-02-24", "categorisation": "string", "mrz_line1": "string", "mrz_line2": "string", "mrz_line3": "string", "address": "string", "place_of_birth": "string", "spouse_name": "string", "widow_name": "string", "alias_name": "string", "issuing_authority": "string", "remarks": "string", "civil_state": "string", "expatriation": "string", "father_name": "string", "mother_name": "string", "religion": "string", "type_of_permit": "string", "version_number": "string", "document_subtype": "string", "profession": "string", "security_document_number": "string", "tax_number": "string", "nist_identity_evidence_strength": "unacceptable", "has_issuance_confirmation": "false", "real_id_compliance": true, "security_tier": "tier_4", "address_lines": { "street_address": "string", "state": "string", "postal_code": "string", "country": "string", "city": "string", "country_code": "string" }, "barcode": [ { "first_name": "string", "middle_name": "string", "last_name": "string", "document_type": "string", "date_of_expiry": "1975-12-18", "date_of_birth": "2000-01-14", "issuing_date": "1957-11-26", "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "address_line_4": "string", "address_line_5": "string", "issuing_state": "string", "class": "string", "gender": "string", "issuing_country": "string", "document_number": "string", "real_id_classification": "string" }, { "first_name": "string", "middle_name": "string", "last_name": "string", "document_type": "string", "date_of_expiry": "1949-08-24", "date_of_birth": "1958-12-15", "issuing_date": "2006-07-22", "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "address_line_4": "string", "address_line_5": "string", "issuing_state": "string", "class": "string", "gender": "string", "issuing_country": "string", "document_number": "string", "real_id_classification": "string" } ], "nfc": { "document_type": "string", "issuing_country": "string", "full_name": "string", "document_number": "string", "nationality": "string", "date_of_birth": "1979-10-17", "gender": "string", "date_of_expiry": "1953-03-09", "personal_number": "string", "place_of_birth": "string", "address": "string", "issuing_date": "1998-06-27", "issuing_authority": "string" }, "document_classification": { "issuing_country": "string", "document_type": "string", "issuing_state": "string" }, "extracted_data": { "document_number": "string", "date_of_birth": "2004-02-20", "date_of_expiry": "1991-02-16", "first_name": "string", "last_name": "string", "middle_name": "string", "full_name": "string", "spouse_name": "string", "widow_name": "string", "alias_name": "string", "gender": "string", "mrz_line1": "string", "mrz_line2": "string", "mrz_line3": "string", "nationality": "string", "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "address_line_4": "string", "address_line_5": "string", "issuing_authority": "string" } } } ] } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Reports" ], "description": "All the reports belonging to a particular check can be listed from this endpoint.\n" } }, "/reports/{report_id}": { "get": { "summary": "Retrieve report", "responses": { "200": { "description": "Report object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "href": { "type": "string" }, "status": { "type": "string" }, "result": { "type": "string" }, "sub_result": { "type": "string" }, "check_id": { "type": "string" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } } }, "breakdown": { "type": "object", "properties": { "data_comparison": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "issuing_country": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "gender": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "date_of_expiry": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "last_name": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_type": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_numbers": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "first_name": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "date_of_birth": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "data_validation": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "gender": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "date_of_birth": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_numbers": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_expiration": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "expiry_date": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "mrz": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "barcode": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "image_integrity": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "image_quality": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object", "properties": { "dark_photo": { "type": "string" }, "glare_on_photo": { "type": "string" }, "blurred_photo": { "type": "string" }, "covered_photo": { "type": "string" }, "other_photo_issue": { "type": "string" }, "damaged_document": { "type": "string" }, "incorrect_side": { "type": "string" }, "cut_off_document": { "type": "string" }, "no_document_in_image": { "type": "string" }, "two_documents_uploaded": { "type": "string" } } } } }, "supported_document": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "colour_picture": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "conclusive_document_quality": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object", "properties": { "obscured_data_points": { "type": "string" }, "obscured_security_features": { "type": "string" }, "abnormal_document_features": { "type": "string" }, "watermarks_digital_text_overlay": { "type": "string" }, "corner_removed": { "type": "string" }, "punctured_document": { "type": "string" }, "missing_back": { "type": "string" }, "digital_document": { "type": "string" } } } } } } } } }, "visual_authenticity": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "fonts": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "picture_face_integrity": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "template": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "security_features": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "original_document_present": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object", "properties": { "photo_of_screen": { "type": "string" }, "screenshot": { "type": "string" }, "document_on_printed_paper": { "type": "string" }, "scan": { "type": "string" } } } } }, "digital_tampering": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "other": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "face_detection": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "data_consistency": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "date_of_expiry": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_numbers": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "issuing_country": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "document_type": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "date_of_birth": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "gender": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "first_name": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "nationality": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "last_name": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "multiple_data_sources_present": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "police_record": { "type": "object", "properties": { "result": { "type": "string" } } }, "compromised_document": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "document_database": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "repeat_attempts": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "age_validation": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "minimum_accepted_age": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } }, "issuing_authority": { "type": "object", "properties": { "result": { "type": "string" }, "breakdown": { "type": "object", "properties": { "nfc_active_authentication": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } }, "nfc_passive_authentication": { "type": "object", "properties": { "result": { "type": "string" }, "properties": { "type": "object" } } } } } } } } }, "properties": { "type": "object", "properties": { "date_of_birth": { "type": "string", "format": "date" }, "date_of_expiry": { "type": "string", "format": "date" }, "personal_number": { "type": "string" }, "document_numbers": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "type": { "type": "string" } } } }, "document_type": { "type": "string" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "gender": { "type": "string" }, "issuing_country": { "type": "string" }, "nationality": { "type": "string" }, "issuing_state": { "type": "string" }, "issuing_date": { "type": "string", "format": "date" }, "valid_from": { "type": "string", "format": "date" }, "categorisation": { "type": "string" }, "mrz_line1": { "type": "string" }, "mrz_line2": { "type": "string" }, "mrz_line3": { "type": "string" }, "address": { "type": "string" }, "place_of_birth": { "type": "string" }, "spouse_name": { "type": "string" }, "widow_name": { "type": "string" }, "alias_name": { "type": "string" }, "issuing_authority": { "type": "string" }, "remarks": { "type": "string" }, "civil_state": { "type": "string" }, "expatriation": { "type": "string" }, "father_name": { "type": "string" }, "mother_name": { "type": "string" }, "religion": { "type": "string" }, "type_of_permit": { "type": "string" }, "version_number": { "type": "string" }, "document_subtype": { "type": "string" }, "profession": { "type": "string" }, "security_document_number": { "type": "string" }, "tax_number": { "type": "string" }, "nist_identity_evidence_strength": { "type": "string" }, "has_issuance_confirmation": { "type": "string" }, "real_id_compliance": { "type": "boolean" }, "security_tier": { "type": "string" }, "address_lines": { "type": "object", "properties": { "street_address": { "type": "string" }, "state": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "country_code": { "type": "string" } } }, "barcode": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "document_type": { "type": "string" }, "date_of_expiry": { "type": "string", "format": "date" }, "date_of_birth": { "type": "string", "format": "date" }, "issuing_date": { "type": "string", "format": "date" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "address_line_3": { "type": "string" }, "address_line_4": { "type": "string" }, "address_line_5": { "type": "string" }, "issuing_state": { "type": "string" }, "class": { "type": "string" }, "gender": { "type": "string" }, "issuing_country": { "type": "string" }, "document_number": { "type": "string" }, "real_id_classification": { "type": "string" } } } }, "nfc": { "type": "object", "properties": { "document_type": { "type": "string" }, "issuing_country": { "type": "string" }, "full_name": { "type": "string" }, "document_number": { "type": "string" }, "nationality": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "gender": { "type": "string" }, "date_of_expiry": { "type": "string", "format": "date" }, "personal_number": { "type": "string" }, "place_of_birth": { "type": "string" }, "address": { "type": "string" }, "issuing_date": { "type": "string", "format": "date" }, "issuing_authority": { "type": "string" } } }, "document_classification": { "type": "object", "properties": { "issuing_country": { "type": "string" }, "document_type": { "type": "string" }, "issuing_state": { "type": "string" } } }, "extracted_data": { "type": "object", "properties": { "document_number": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "date_of_expiry": { "type": "string", "format": "date" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "middle_name": { "type": "string" }, "full_name": { "type": "string" }, "spouse_name": { "type": "string" }, "widow_name": { "type": "string" }, "alias_name": { "type": "string" }, "gender": { "type": "string" }, "mrz_line1": { "type": "string" }, "mrz_line2": { "type": "string" }, "mrz_line3": { "type": "string" }, "nationality": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "address_line_3": { "type": "string" }, "address_line_4": { "type": "string" }, "address_line_5": { "type": "string" }, "issuing_authority": { "type": "string" } } } } } } }, "example": { "id": "d0e814a4-b12f-997f-9370-8c12252d7290", "name": "india_pan", "created_at": "1993-02-26T03:14:54.063Z", "href": "string", "status": "cancelled", "result": "unidentified", "sub_result": "caution", "check_id": "528315b5-d934-d28d-1b6c-2daed1e7f43d", "documents": [ { "id": "d2ff74c2-39d7-a6ec-50ec-1ced84af2add" }, { "id": "da7dec46-8cd9-b02f-43af-f54108379066" } ], "breakdown": { "data_comparison": { "result": "string", "breakdown": { "issuing_country": { "result": "string", "properties": {} }, "gender": { "result": "string", "properties": {} }, "date_of_expiry": { "result": "string", "properties": {} }, "last_name": { "result": "string", "properties": {} }, "document_type": { "result": "string", "properties": {} }, "document_numbers": { "result": "string", "properties": {} }, "first_name": { "result": "string", "properties": {} }, "date_of_birth": { "result": "string", "properties": {} } } }, "data_validation": { "result": "string", "breakdown": { "gender": { "result": "string", "properties": {} }, "date_of_birth": { "result": "string", "properties": {} }, "document_numbers": { "result": "string", "properties": {} }, "document_expiration": { "result": "string", "properties": {} }, "expiry_date": { "result": "string", "properties": {} }, "mrz": { "result": "string", "properties": {} }, "barcode": { "result": "string", "properties": {} } } }, "image_integrity": { "result": "string", "breakdown": { "image_quality": { "result": "string", "properties": { "dark_photo": "string", "glare_on_photo": "string", "blurred_photo": "string", "covered_photo": "string", "other_photo_issue": "string", "damaged_document": "string", "incorrect_side": "string", "cut_off_document": "string", "no_document_in_image": "string", "two_documents_uploaded": "string" } }, "supported_document": { "result": "string", "properties": {} }, "colour_picture": { "result": "string", "properties": {} }, "conclusive_document_quality": { "result": "string", "properties": { "obscured_data_points": "string", "obscured_security_features": "string", "abnormal_document_features": "string", "watermarks_digital_text_overlay": "string", "corner_removed": "string", "punctured_document": "string", "missing_back": "string", "digital_document": "string" } } } }, "visual_authenticity": { "result": "string", "breakdown": { "fonts": { "result": "string", "properties": {} }, "picture_face_integrity": { "result": "string", "properties": {} }, "template": { "result": "string", "properties": {} }, "security_features": { "result": "string", "properties": {} }, "original_document_present": { "result": "string", "properties": { "photo_of_screen": "string", "screenshot": "string", "document_on_printed_paper": "string", "scan": "string" } }, "digital_tampering": { "result": "string", "properties": {} }, "other": { "result": "string", "properties": {} }, "face_detection": { "result": "string", "properties": {} } } }, "data_consistency": { "result": "string", "breakdown": { "date_of_expiry": { "result": "string", "properties": {} }, "document_numbers": { "result": "string", "properties": {} }, "issuing_country": { "result": "string", "properties": {} }, "document_type": { "result": "string", "properties": {} }, "date_of_birth": { "result": "string", "properties": {} }, "gender": { "result": "string", "properties": {} }, "first_name": { "result": "string", "properties": {} }, "nationality": { "result": "string", "properties": {} }, "last_name": { "result": "string", "properties": {} }, "multiple_data_sources_present": { "result": "string", "properties": {} } } }, "police_record": { "result": "string" }, "compromised_document": { "result": "string", "breakdown": { "document_database": { "result": "string", "properties": {} }, "repeat_attempts": { "result": "string", "properties": {} } } }, "age_validation": { "result": "string", "breakdown": { "minimum_accepted_age": { "result": "string", "properties": {} } } }, "issuing_authority": { "result": "string", "breakdown": { "nfc_active_authentication": { "result": "string", "properties": {} }, "nfc_passive_authentication": { "result": "string", "properties": {} } } } }, "properties": { "date_of_birth": "2020-01-17", "date_of_expiry": "1983-04-04", "personal_number": "string", "document_numbers": [ { "value": "string", "type": "string" }, { "value": "string", "type": "string" } ], "document_type": "string", "first_name": "string", "middle_name": "string", "last_name": "string", "gender": "string", "issuing_country": "string", "nationality": "string", "issuing_state": "string", "issuing_date": "1982-07-13", "valid_from": "2015-01-05", "categorisation": "string", "mrz_line1": "string", "mrz_line2": "string", "mrz_line3": "string", "address": "string", "place_of_birth": "string", "spouse_name": "string", "widow_name": "string", "alias_name": "string", "issuing_authority": "string", "remarks": "string", "civil_state": "string", "expatriation": "string", "father_name": "string", "mother_name": "string", "religion": "string", "type_of_permit": "string", "version_number": "string", "document_subtype": "string", "profession": "string", "security_document_number": "string", "tax_number": "string", "nist_identity_evidence_strength": "weak", "has_issuance_confirmation": "true", "real_id_compliance": false, "security_tier": "tier_5", "address_lines": { "street_address": "string", "state": "string", "postal_code": "string", "country": "string", "city": "string", "country_code": "string" }, "barcode": [ { "first_name": "string", "middle_name": "string", "last_name": "string", "document_type": "string", "date_of_expiry": "1963-04-30", "date_of_birth": "1949-10-13", "issuing_date": "2009-07-06", "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "address_line_4": "string", "address_line_5": "string", "issuing_state": "string", "class": "string", "gender": "string", "issuing_country": "string", "document_number": "string", "real_id_classification": "string" }, { "first_name": "string", "middle_name": "string", "last_name": "string", "document_type": "string", "date_of_expiry": "1947-04-07", "date_of_birth": "2012-05-29", "issuing_date": "2021-08-18", "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "address_line_4": "string", "address_line_5": "string", "issuing_state": "string", "class": "string", "gender": "string", "issuing_country": "string", "document_number": "string", "real_id_classification": "string" } ], "nfc": { "document_type": "string", "issuing_country": "string", "full_name": "string", "document_number": "string", "nationality": "string", "date_of_birth": "1983-08-07", "gender": "string", "date_of_expiry": "2021-03-09", "personal_number": "string", "place_of_birth": "string", "address": "string", "issuing_date": "2014-01-08", "issuing_authority": "string" }, "document_classification": { "issuing_country": "string", "document_type": "string", "issuing_state": "string" }, "extracted_data": { "document_number": "string", "date_of_birth": "1959-09-14", "date_of_expiry": "1997-11-29", "first_name": "string", "last_name": "string", "middle_name": "string", "full_name": "string", "spouse_name": "string", "widow_name": "string", "alias_name": "string", "gender": "string", "mrz_line1": "string", "mrz_line2": "string", "mrz_line3": "string", "nationality": "string", "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "address_line_4": "string", "address_line_5": "string", "issuing_authority": "string" } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Reports" ], "description": "A single report can be retrieved using this endpoint with the corresponding unique identifier.\n" }, "parameters": [ { "name": "report_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/reports/{report_id}/resume": { "post": { "summary": "Resume report", "responses": { "204": { "description": "No Content" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Reports" ], "description": "Resumes a single paused report.\n" }, "parameters": [ { "name": "report_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] }, "/reports/{report_id}/cancel": { "post": { "summary": "Cancel report", "responses": { "204": { "description": "No Content" }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "properties": { "key_0": { "type": "number" }, "key_1": { "type": "integer" }, "key_2": { "type": "number" } } } } } } }, "example": { "error": { "type": "string", "message": "string", "fields": { "key_0": 5595.629784270513, "key_1": 1825, "key_2": 9195.194520545147 } } } } } } }, "tags": [ "Other Endpoints", "Reports" ], "description": "Cancels single paused reports.\n" }, "parameters": [ { "name": "report_id", "in": "path", "required": true, "description": "(Required) ", "schema": { "type": "string" }, "example": "fb2f1864-95c0-0d31-ef3f-21930ee281c4" } ] } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization" } } }, "security": [ { "ApiKeyAuth": [] } ] }