Checkout.com - Identity Verification (1.0.0)

Download OpenAPI specification:Download

Applicants

Create an Applicant

This section describes all endpoints related to applicants. It will enable you to create and manage applicant objects.

Request Body schema: application/json

external_applicant_id	string
external_applicant_name	string
email	string <email>

Responses

Request samples

Payload

Content type

application/json

{"external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
"external_applicant_name": "David Vincent",
"email": "david.vincent@courriel.ml"
}

Response samples

201
400

Content type

application/json

{"id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
"external_applicant_name": "David Vincent",
"email": "david.vincent@courriel.ml",
"_links": {"self": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve an Applicant

path Parameters

applicant_id

required

string (ApplicantId) ^aplt_\w+$

Example: aplt_tkoi5db4hryu5cei5vwoabr7we

ID of Applicant to return

Responses

Response samples

200

Content type

application/json

{"id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
"external_applicant_name": "David Vincent",
"email": "david.vincent@courriel.ml",
"_links": {"self": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Update an Applicant

path Parameters

applicant_id

required

string (ApplicantId) ^aplt_\w+$

Example: aplt_tkoi5db4hryu5cei5vwoabr7we

ID of Applicant to return

Request Body schema: application/json

external_applicant_name	string
email	string <email>

Responses

Request samples

Payload

Content type

application/json

{"external_applicant_name": "David Vincent",
"email": "david.vincent@courriel.ml"
}

Response samples

200

Content type

application/json

{"id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
"external_applicant_name": "David Vincent",
"email": "david.vincent@courriel.ml",
"_links": {"self": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Anonymize an Applicant

Anonymize the personal data of an applicant with the specified ID.

path Parameters

applicant_id

required

string

ID of the applicant to anonymize

Responses

Response samples

200

Content type

application/json

{"id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
"external_applicant_name": "David Vincent",
"_links": {"self": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Business applicants

Create a Business Applicant

This section describes all endpoints related to business applicants. It will enable you to create and manage business applicant objects.

Request Body schema: application/json

external_applicant_id

string

Responses

Request samples

Payload

Content type

application/json

{"external_applicant_id": "ext_business_osdfdfdb4hryu5cei5vwoabrk5k"
}

Response samples

201
400

Content type

application/json

{"id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"external_applicant_id": "ext_business_osdfdfdb4hryu5cei5vwoabrk5k",
"_links": {"self": {"href": "https://api.ubble.ai/v2/business-applicants/bplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve a Business Applicant

path Parameters

business_applicant_id

required

string (BusinessApplicantId) ^bplt_\w+$

Example: bplt_tkoi5db4hryu5cei5vwoabr7we

ID of Business Applicant to return

Responses

Response samples

200

Content type

application/json

{"id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"external_applicant_id": "ext_business_osdfdfdb4hryu5cei5vwoabrk5k",
"_links": {"self": {"href": "https://api.ubble.ai/v2/business-applicants/bplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Identity verifications

Create and start an identity verification

This endpoint allows you to create and identity verification. You should get a 201 response and the identity verification resource containing the _links/verification_url.

Request Body schema: application/json
required

required	object (IdentityDeclaredData)
	object (PhoneNumber)
redirect_url required	string <uri>
mobile_handoff_url	string or null <uri> <= 512 characters Optional. URL encoded in the QR code shown when the verification is opened on a desktop, so the end user can continue on their phone through your own flow. Defaults to the verification URL. Accepts https URLs and app deeplinks. Max 512 characters.
user_journey_id	string^usj_\w+$ User journey unique identifier.
applicant_id	string^aplt_\w+$ Applicant unique identifier.
webhook_url required	string <uri>

Responses

Callbacks

Request samples

Payload

Content type

application/json

Example

Only required data

{"declared_data": {"name": "David Vincent"
},
"webhook_url": "https://my.api/events/",
"redirect_url": "https://myweb.site?query-param=hello"
}

Response samples

201

Content type

application/json

{"id": "idv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "pending",
"response_codes": [ ],
"risk_labels": [ ],
"declared_data": {"name": "David Vincent"
},
"documents": [ ],
"webhook_url": "https://my.api/events/",
"redirect_url": "https://myweb.site?query-param=hello",
"_links": {"self": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
},
"verification_url": {"href": "https://id.ubble.ai/4hryu5cei5/"
}
}
}

Callback payload samples

Callback

POST: Status update notification

Content type

application/json

{"specversion": "2.0",
"type": "identity_verification_capture_completed",
"subject": "idv_5hxpdwegjcbujpth3wdo55d3vm",
"id": "evnt_5hxpdwegjcbujpth3wdo55d3vm",
"time": "2023-03-22T17:31:00Z",
"datacontenttype": "application/json",
"data": {"applicant_id": "aplt_5hxpdwegjcbujpth3wdo55d3vm",
"user_journey_id": "usj_5hxpdwegjcbujpth3wdo55d3vm",
"identity_verification_id": "idv_5hxpdwegjcbujpth3wdo55d3vm",
"status": "declined",
"response_codes": [{"code": 61310,
"summary": "document_front_not_captured"
},
{"code": 62102,
"summary": "document_not_accepted"
}
]
}
}

Create an identity verification

Creates an identity verification.

When this request is successful, you'll get a 201 response with the identity verification resource.

Request Body schema: application/json
required

required	object (IdentityDeclaredData)
user_journey_id	string^usj_\w+$ User journey unique identifier.
applicant_id required	string^aplt_\w+$ Applicant unique identifier.
webhook_url required	string <uri>

Responses

Request samples

Payload

Content type

application/json

Example

Only required data

{"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"declared_data": {"name": "John Smith"
},
"webhook_url": "https://my.api/events/"
}

Response samples

201

Content type

application/json

{"id": "idv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"risk_labels": [ ],
"declared_data": {"name": "David Vincent"
},
"documents": [ ],
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve an identity verification

This endpoint allows you to get the detailed results of an identity verification.

path Parameters

identity_verification_id

required

string (IdentityVerificationId) ^idv_\w+$

Example: idv_tkoi5db4hryu5cei5vwoabr7we

ID of the identity verification

Responses

Response samples

200

Content type

application/json

{"id": "idv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "declined",
"response_codes": [{"code": 61310,
"summary": "document_front_not_captured"
},
{"code": 62102,
"summary": "document_not_accepted"
}
],
"risk_labels": ["multiple_faces_detected"
],
"verified_identity": {"full_name": "David Vincent",
"birth_date": "1934-10-02"
},
"certifications": [{"type": "diatf",
"data": {"gpg45_profile": "M1A",
"level_of_confidence": "high",
"right_to_work": "GRANTED"
}
}
],
"declared_data": {"name": "David Vincent"
},
"documents": [{"full_name": "David Vincent",
"birth_date": "1934-10-02",
"document_type": "ID",
"document_issuing_country": "US",
"front_image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
}
],
"face": {"image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
},
"phone_number": {"country_code": "+1",
"number": "2068133616"
},
"webhook_url": "https://my.api/events/",
"redirect_url": "https://myweb.site?query-param=hello",
"_links": {"self": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
},
"verification_url": {"href": "https://id.ubble.ai/4hryu5cei5/"
}
}
}

Anonymize an identity verification

Anonymize the personal data of an identity verification with the specified ID.

path Parameters

identity_verification_id

required

string

ID of the identity verification to anonymize

Responses

Response samples

200

Content type

application/json

{"id": "idv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "pending",
"response_codes": [ ],
"risk_labels": ["multiple_faces_detected"
],
"phone_number": {"country_code": "+1",
"number": "5555550102"
},
"documents": [ ],
"webhook_url": "https://my.api/events/",
"redirect_url": "https://myweb.site?query-param=hello",
"_links": {"self": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

List attempts

This endpoint allows you to list all attempts of a verification.

Attempts are returned ordered by creation date, newest first.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

identity_verification_id

required

string

ID of the identity verification

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 2,
"skip": 10,
"limit": 10,
"data": [{"id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "checks_in_progress",
"response_codes": [ ],
"phone_number": {"country_code": "+1",
"number": "2068133616"
},
"redirect_url": "https://myweb.site?query-param=hello",
"client_information": {"pre_selected_residence_country": "FR",
"pre_selected_document_issuing_country": "FR",
"pre_selected_document_type": "ID"
},
"applicant_session_information": {"ip_address": "123.123.123.01"
},
"_links": {"self": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts/iatp_idv_tkoi5db4hryu5cei5vwoabr7we"
},
"verification_url": {"href": "https://id.ubble.ai/4hryu5cei5/"
}
}
}
],
"_links": {"self": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=10&limit=10"
},
"next": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=20&limit=10"
},
"previous": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=0&limit=10"
}
}
}

Create an attempt

This endpoint allows you to create a new Attempt. It is possible when the identity-verification is in one of the following statuses created, pending, capture_in_progress, retry_required

path Parameters

identity_verification_id

required

string

ID of the identity verification

Request Body schema: application/json

	object (PhoneNumber)
	object (IdentityClientInformation)
redirect_url required	string <uri>
mobile_handoff_url	string or null <uri> <= 512 characters Optional. URL encoded in the QR code shown when the verification is opened on a desktop, so the end user can continue on their phone through your own flow. Defaults to the verification URL. Accepts https URLs and app deeplinks. Max 512 characters.

Responses

Request samples

Payload

Content type

application/json

Example

Minimal body

{"redirect_url": "https://myweb.site?query-param=hello"
}

Response samples

201

Content type

application/json

{"id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"phone_number": {"country_code": "+1",
"number": "2068133616"
},
"client_information": {"pre_selected_residence_country": "FR",
"pre_selected_document_issuing_country": "FR",
"pre_selected_document_type": "ID"
},
"redirect_url": "https://myweb.site?query-param=hello",
"mobile_handoff_url": "https://myweb.site/continue-on-mobile?session=a1b2c3",
"applicant_session_information": {"ip_address": "33.333.333.33"
},
"_links": {"self": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts/iatp_idv_tkoi5db4hryu5cei5vwoabr7we"
},
"verification_url": {"href": "https://id.ubble.ai/4hryu5cei5/"
}
}
}

Retrieve an attempt

This endpoint allows you to retrieve the details for a given attempt

path Parameters

identity_verification_id required	string ID of the identity verification
attempt_id required	string ID of the attempt

Responses

Response samples

200

Content type

application/json

{"id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"phone_number": {"country_code": "+1",
"number": "2068133616"
},
"redirect_url": "https://myweb.site?query-param=hello",
"status": "checks_in_progress",
"response_codes": [ ],
"client_information": {"pre_selected_residence_country": "FR",
"pre_selected_document_issuing_country": "FR",
"pre_selected_document_type": "ID"
},
"applicant_session_information": {"ip_address": "123.123.123.01",
"selected_documents": [{"country": "FR",
"document_type": "Passport"
}
]
},
"_links": {"self": {"href": "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts/iatp_idv_tkoi5db4hryu5cei5vwoabr7we"
},
"verification_url": {"href": "https://id.ubble.ai/4hryu5cei5/"
}
}
}

Retrieve attempt assets

Retrieves the assets associated with an identity verification attempt. This includes face images, videos, and document images captured during the verification process. Please note that videos are not exposed by default, contact your account manager to enable this feature.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

identity_verification_id required	string The ID of the identity verification
attempt_id required	string The ID of the attempt

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"data": [{"_links": {"asset_url": {"href": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
}
},
"type": "face_image"
},
{"_links": {"asset_url": {"href": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
}
},
"type": "face_video"
},
{"_links": {"asset_url": {"href": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
}
},
"type": "document_front_image"
},
{"_links": {"asset_url": {"href": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
}
},
"type": "document_front_video"
}
],
"_links": {"self": {"href": "https://api.ubble.ai/api/v2/face-authentications/fau_116kcr6z00h62kzvf4hw2twb3b/attempts/fatp_116kcr6z00h62kzvf4hw2twb3d/assets"
}
},
"limit": 10,
"skip": 0,
"total_count": 4
}

Request webhook notification

This endpoint can be used to initiate a webhook call containing the latest event of an identity verification.

path Parameters

identity_verification_id

required

string

ID of the identity verification to notify

Request Body schema: application/json

webhook_url

string <uri>

Responses

Request samples

Payload

Content type

application/json

{"webhook_url": "http://example.com"
}

Retrieve PDF report of an identity verification

This endpoint allows you to retrieve a PDF report containing all the information of the identity verification.

Please note that this report is only available for verifications in statuses declined and approved once you receive the identity_verification_report_created event.

path Parameters

identity_verification_id

required

string

ID of the identity verification

Responses

Response samples

200

Content type

application/json

{"pdf_report": "https://www.example.com/reports/idv_123.pdf"
}

ID document verifications

API for ID document verification

Create an ID document verification

Creates an ID document verification

Request Body schema: application/json
required

user_journey_id required	string^usj_\w+$ User journey unique identifier.
applicant_id required	string^aplt_\w+$ Applicant unique identifier.
	object (DeclaredData)
webhook_url	string <uri>

Responses

Request samples

Payload

Content type

application/json

Example

id_document_verification_creation_request_body_min

{"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"declared_data": {"name": "David Vincent"
}
}

Response samples

201

Content type

application/json

{"id": "iddv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"declared_data": {"name": "David Vincent"
},
"document": {"full_name": "David Vincent",
"birth_date": "1934-10-02",
"document_type": "ID",
"document_issuing_country": "US",
"front_image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
},
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve an ID document verification

This endpoint allows you to get the detailed results of an ID document verification

path Parameters

id_document_verification_id

required

string (IdDocumentVerificationId) ^iddv_\w+$

Example: iddv_tkoi5db4hryu5cei5vwoabr7we

ID ocument verification unique identifier.

Responses

Response samples

200

Content type

application/json

{"id": "iddv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"declared_data": {"name": "David Vincent"
},
"document": {"full_name": "David Vincent",
"birth_date": "1934-10-02",
"document_type": "ID",
"document_issuing_country": "US",
"front_image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
},
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Anonymize an ID document verification

Anonymize the personal data of an ID document verification with the specified ID.

path Parameters

id_document_verification_id

required

string

ID of the document verification to anonymize

Responses

Response samples

200

Content type

application/json

{"id": "iddv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

List ID document verification attempts

This endpoint allows you to list all attempts of an ID document verification.

Attempts are returned ordered by creation date, newest first.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

id_document_verification_id

required

string

ID of the document verification

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 2,
"skip": 10,
"limit": 10,
"data": [{"id": "iddv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
}
}
}
],
"_links": {"self": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts"
},
"next": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
},
"previous": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
}
}
}

Create an ID document verification attempt

This endpoint allows you to create an ID document verification attempt. It is possible when the ID document verification is one of the following statuses: created, retry_required

path Parameters

id_document_verification_id

required

string

ID of the document verification

Request Body schema: multipart/form-data
required

document_front required	string <binary>
document_back	string <binary>

Responses

Request samples

Payload

Content type

multipart/form-data

Example

id_document_verification_attempt_creation_request_body_min

{
  "document_front": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…\n"
}

Response samples

201

Content type

application/json

{"id": "iddv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve an ID document verification attempt

This endpoint allows you to retrieve the details for a given ID document verification attempt

path Parameters

id_document_verification_id required	string ID of the document verification
attempt_id required	string ID of the document verification attempt

Responses

Response samples

200

Content type

application/json

{"id": "iddv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve an ID document verification attempt asset

This endpoint allows you to retrieve the assets associated with an ID document verification. This includes the document front image and the document back image.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

id_document_verification_id required	string ID of the ID document verification
attempt_id required	string ID of the ID document verification attempt

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 2,
"skip": 10,
"limit": 10,
"_links": {"self": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts"
},
"next": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
},
"previous": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
}
},
"data": [{"type": "document_front_image",
"_links": {"asset_url": {"href": "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/assets/document_front_image"
}
}
}
]
}

Request webhook notification

This endpoint can be used to initiate a webhook call containing the latest event of an ID document verification

path Parameters

id_document_verification_id

required

string

ID of the document verification to notify

Request Body schema: application/json

webhook_url

string <uri>

Responses

Request samples

Payload

Content type

application/json

{"webhook_url": "http://example.com"
}

Retrieve PDF report of an ID document verification

This endpoint allows you to retrieve a PDF report of an ID document verification.

Please note that the PDF report is only available for ID document verifications that are in status declined and approved once you receive the id_document_verification_report_created event.

path Parameters

id_document_verification_id

required

string

ID of the ID document verification

Responses

Response samples

200

Content type

application/json

{"pdf_report": "https://www.example.com/reports/iddv_123.pdf"
}

Face authentications

Create a face authentication

This endpoint allows you to create a face authentication.

Request Body schema: application/json
required

user_journey_id required	string (UserJourneyId) ^usj_\w+$ User journey unique identifier.
applicant_id required	string (ApplicantId) ^aplt_\w+$ Applicant unique identifier.
webhook_url required	string <uri>

Responses

Request samples

Payload

Content type

application/json

{"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"webhook_url": "http://example.com"
}

Response samples

201

Content type

application/json

{"id": "fav_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "declined",
"response_codes": [{"code": 62403,
"summary": "consent_unclear"
},
{"code": 61402,
"summary": "face_video_lighting_issue"
}
],
"risk_labels": ["multiple_faces_detected"
],
"face": {"image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
},
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve a face authentication

This endpoint allows you to get the detailed results of a face authentication.

path Parameters

face_authentication_id

required

string (FaceAuthenticationId) ^fav_\w+$

Example: fav_tkoi5db4hryu5cei5vwoabr7we

ID of the face authentication

Responses

Response samples

200

Content type

application/json

{"id": "fav_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "declined",
"response_codes": [{"code": 62403,
"summary": "consent_unclear"
},
{"code": 61402,
"summary": "face_video_lighting_issue"
}
],
"risk_labels": ["multiple_faces_detected"
],
"face": {"image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
},
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Anonymize a face authentication

Anonymize the personal data of a face authentication with the specified ID.

path Parameters

face_authentication_id

required

string

ID of the face authentication to anonymize

Responses

Response samples

200

Content type

application/json

{"id": "fav_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "declined",
"response_codes": [{"code": 62403,
"summary": "consent_unclear"
},
{"code": 61402,
"summary": "face_video_lighting_issue"
}
],
"risk_labels": ["multiple_faces_detected"
],
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/face-authentications/face_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

List attempts

This endpoint allows you to list all attempts of a face authentication.

Attempts are returned ordered by creation date, newest first.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

face_authentication_id

required

string

ID of the face authentication

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 2,
"skip": 10,
"limit": 10,
"data": [{"id": "fatp_tkoi5db4hryu5cei5vwoabrPoQ",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "checks_in_progress",
"response_codes": [ ],
"phone_number": {"country_code": "+1",
"number": "2068133616"
},
"redirect_url": "https://myweb.site?query-param=hello",
"client_information": {"pre_selected_residence_country": "FR"
},
"applicant_session_information": {"ip_address": "123.123.123.01"
},
"_links": {"verification_url": {"href": "https://id.ubble.ai/4hryu5cei5/"
},
"self": {"href": "https://api.ubble.ai/face-authentications/4hryu5cei5/fatp_tkoi5db4hryu5cei5vwoabrPoQ"
}
}
},
{"id": "fatp_tkoi5db4hryu5cei5vwoabriom",
"created_on": "2017-07-21T16:30:28Z",
"modified_on": "2017-07-21T16:32:32Z",
"status": "checks_inconclusive",
"response_codes": [{"code": 61402,
"summary": "face_video_lighting_issue"
}
],
"phone_number": {"country_code": "+1",
"number": "2068133616"
},
"redirect_url": "https://myweb.site?query-param=hello",
"client_information": {"pre_selected_residence_country": "FR"
},
"applicant_session_information": {"ip_address": "123.123.123.01"
},
"_links": {"self": {"href": "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts/fatp_tkoi5db4hryu5cei5vwoabr7we"
},
"verification_url": {"href": "https://id.ubble.ai/4hryu5clik/"
}
}
}
],
"_links": {"self": {"href": "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=10&limit=10"
},
"next": {"href": "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=20&limit=10"
},
"previous": {"href": "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=0&limit=10"
}
}
}

Create an attempt

This endpoint allows you to create a new Attempt. It is possible when the face-authentication is in one of the following statuses created, pending, capture_in_progress, retry_required

path Parameters

face_authentication_id

required

string

ID of the face authentication

Request Body schema: application/json

	object (PhoneNumber)
	object (FaceAttemptClientInformation)
redirect_url required	string <uri>
mobile_handoff_url	string or null <uri> <= 512 characters Optional. URL encoded in the QR code shown when the verification is opened on a desktop, so the end user can continue on their phone through your own flow. Defaults to the verification URL. Accepts https URLs and app deeplinks. Max 512 characters.

Responses

Request samples

Payload

Content type

application/json

Example

Minimal body

{"redirect_url": "https://myweb.site?query-param=hello"
}

Response samples

201

Content type

application/json

{"id": "fatp_tkoi5db4hryu5cei5vwoabrPoQ",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "pending_redirection",
"response_codes": [ ],
"phone_number": {"country_code": "+1",
"number": "2068133616"
},
"client_information": {"pre_selected_residence_country": "FR"
},
"redirect_url": "https://myweb.site?query-param=hello",
"mobile_handoff_url": "https://myweb.site/continue-on-mobile?session=a1b2c3",
"_links": {"self": {"href": "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts/fatp_tkoi5db4hryu5cei5vwoabr7we"
},
"verification_url": {"href": "https://id.ubble.ai/4hryu5cei5/"
}
}
}

Retrieve an attempt

This endpoint allows you to retrieve the details for a given attempt

path Parameters

face_authentication_id required	string ID of the face authentication
attempt_id required	string ID of the attempt

Responses

Response samples

200

Content type

application/json

{"id": "fatp_tkoi5db4hryu5cei5vwoabrPoQ",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"phone_number": {"country_code": "+1",
"number": "2068133616"
},
"redirect_url": "https://myweb.site?query-param=hello",
"status": "checks_in_progress",
"response_codes": [ ],
"client_information": {"pre_selected_residence_country": "FR"
},
"applicant_session_information": {"ip_address": "123.123.123.01"
},
"_links": {"self": {"href": "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts/fatp_tkoi5db4hryu5cei5vwoabr7we"
},
"verification_url": {"href": "https://id.ubble.ai/4hryu5cei5/"
}
}
}

Retrieve attempt assets

Retrieves the assets associated with a face authentication attempt. This includes face images and videos captured during the verification process. Please note that videos are not exposed by default, contact your account manager to enable this feature.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

face_authentication_id required	string The ID of the face authentication
attempt_id required	string The ID of the attempt

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"data": [{"_links": {"asset_url": {"href": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
}
},
"type": "face_image"
},
{"_links": {"asset_url": {"href": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
}
},
"type": "face_video"
}
],
"_links": {"self": {"href": "https://api.ubble.ai/api/v2/face-authentications/fau_116kcr6z00h62kzvf4hw2twb3b/attempts/fatp_116kcr6z00h62kzvf4hw2twb3d/assets"
}
},
"limit": 10,
"skip": 0,
"total_count": 2
}

Request webhook notification

This endpoint can be used to initiate a webhook call containing the latest event of a face authentication.

path Parameters

face_authentication_id

required

string

ID of the face authentication to notify

Request Body schema: application/json

webhook_url

string <uri>

Responses

Request samples

Payload

Content type

application/json

{"webhook_url": "http://example.com"
}

AML verifications

AML verification endpoints documentation.

Create an AML verification

This endpoint allows you to create an AML verification. You should get a 201 response.

Request Body schema: application/json
required

webhook_url required	string <uri>
applicant_id required	string^aplt_\w+$ Applicant unique identifier.
required	object (SearchParameters) ComplyAdvantage search inputs
monitored	boolean

Responses

Request samples

Payload

Content type

application/json

Example

Only required data

{"search_parameters": {"configuration_identifier": "011e5c14-2222-738c-8852-dfdbbe53f233"
},
"webhook_url": "https://my.api/events/",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we"
}

Response samples

201

Content type

application/json

{"id": "amlv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "created",
"webhook_url": "https://my.api/events/",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"search_parameters": {"configuration_identifier": "8eb79430-c014-41e5-be73-2c2c091322b8"
},
"monitored": false,
"_links": {"self": {"href": "https://api.ubble.ai/v2/aml-verifications/amlv_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve an AML verification

This endpoint allows you to get the detailed results of an AML verification.

path Parameters

aml_verification_id

required

string (AMLVerificationId) ^amlv_\w+$

Example: amlv_tkoi5db4hryu5cei5vwoabr7we

ID of the AML verification

Responses

Response samples

200

Content type

application/json

{"id": "amlv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "created",
"webhook_url": "https://my.api/events/",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"search_parameters": {"configuration_identifier": "8eb79430-c014-41e5-be73-2c2c091322b8"
},
"monitored": false,
"_links": {"self": {"href": "https://api.ubble.ai/v2/aml-verifications/amlv_tkoi5db4hryu5cei5vwoabr7we"
},
"applicant": {"href": "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Website verifications (Coming soon)

Create a website verification

Creates a website verification

Request Body schema: application/json
required

user_journey_id required	string^usj_\w+$ User journey unique identifier.
applicant_id required	string^bplt_\w+$ Business Applicant unique identifier.
webhook_url	string <uri>
website_url required	string <uri> <= 1024 characters URL of the website to be verified

Responses

Request samples

Payload

Content type

application/json

{"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"webhook_url": "http://example.com",
"website_url": "http://example.com"
}

Response samples

201

Content type

application/json

{"id": "wbv_tkoi5db4hryu5cei5vwoabr7we",
"status": "initial_status",
"response_codes": [{"code": 10000,
"summary": "string"
}
],
"risk_labels": ["multiple_faces_detected"
],
"website_data": {"legal_name": "string",
"country_of_incorporation": "US",
"mccs": ["string"
],
"alternative_mccs": ["string"
],
"mcc_rationale": "string",
"risky_activities": ["string"
],
"legal_address": {"address_line1": "string",
"address_line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "US"
},
"disclosure_urls": {"privacy_policy_url": "http://example.com",
"terms_and_conditions_url": "http://example.com",
"refund_policy_url": "http://example.com",
"contact_us_url": "http://example.com"
},
"registration_date": "2019-08-24"
},
"_links": {"self": {"href": "http://example.com"
},
"applicant": {"href": "http://example.com"
}
},
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"webhook_url": "http://example.com",
"website_url": "http://example.com",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z"
}

Retrieve a website verification

This endpoint allows you to get the detailed results of a website verification

path Parameters

website_verification_id

required

string (WebsiteVerificationId) ^wbv_\w+$

Example: wbv_tkoi5db4hryu5cei5vwoabr7we

Website verification unique identifier.

Responses

Response samples

200

Content type

application/json

{"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"id": "wbv_tkoi5db4hryu5cei5vwoabr7we",
"status": "initial_status",
"response_codes": [{"code": 10000,
"summary": "string"
}
],
"risk_labels": ["multiple_faces_detected"
],
"website_data": {"legal_name": "string",
"country_of_incorporation": "US",
"mccs": ["string"
],
"alternative_mccs": ["string"
],
"mcc_rationale": "string",
"risky_activities": ["string"
],
"legal_address": {"address_line1": "string",
"address_line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "US"
},
"disclosure_urls": {"privacy_policy_url": "http://example.com",
"terms_and_conditions_url": "http://example.com",
"refund_policy_url": "http://example.com",
"contact_us_url": "http://example.com"
},
"registration_date": "2019-08-24"
},
"_links": {"self": {"href": "http://example.com"
},
"applicant": {"href": "http://example.com"
}
},
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"webhook_url": "http://example.com",
"website_url": "http://example.com"
}

Anonymize a website verification

Anonymize the personal data of a website verification with the specified ID.

path Parameters

website_verification_id

required

string

ID of the website verification to anonymize

Responses

Response samples

200

Content type

application/json

{"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"id": "wbv_tkoi5db4hryu5cei5vwoabr7we",
"status": "initial_status",
"response_codes": [{"code": 10000,
"summary": "string"
}
],
"risk_labels": ["multiple_faces_detected"
],
"website_data": {"legal_name": "string",
"country_of_incorporation": "US",
"mccs": ["string"
],
"alternative_mccs": ["string"
],
"mcc_rationale": "string",
"risky_activities": ["string"
],
"legal_address": {"address_line1": "string",
"address_line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "US"
},
"disclosure_urls": {"privacy_policy_url": "http://example.com",
"terms_and_conditions_url": "http://example.com",
"refund_policy_url": "http://example.com",
"contact_us_url": "http://example.com"
},
"registration_date": "2019-08-24"
},
"_links": {"self": {"href": "http://example.com"
},
"applicant": {"href": "http://example.com"
}
},
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"webhook_url": "http://example.com",
"website_url": "http://example.com"
}

Request webhook notification

This endpoint can be used to initiate a webhook call containing the latest event of a website verification

path Parameters

website_verification_id

required

string

ID of the website verification to notify

Request Body schema: application/json

webhook_url

string <uri>

Responses

Request samples

Payload

Content type

application/json

{"webhook_url": "http://example.com"
}

Bank document verifications (Coming soon)

Create a Bank Document Verification

Creates a Bank Document Verification

Request Body schema: application/json
required

user_journey_id required	string^usj_\w+$ User journey unique identifier.
applicant_id required	string^bplt_\w+$ Business Applicant unique identifier.
webhook_url	string <uri>
	object (BankDocumentVerificationDeclaredData)

Responses

Request samples

Payload

Content type

application/json

Example

bank_document_verification_creation_request_body_min

{"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"declared_data": {"registered_name": "Acme Corporation",
"trading_name": "Acme Corp"
}
}

Response samples

201

Content type

application/json

{"id": "bdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"declared_data": {"registered_name": "Acme Corporation",
"trading_name": "Acme Corp"
},
"bank_document": {"bank_account_number": "1234567890",
"bank_routing_number": "987654321",
"account_type": "checking",
"legal_name": "Acme Corporation",
"bank_name": "First National Bank",
"issue_date": "2023-01-15",
"document_type": "bank_statement"
},
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve a Bank Document Verification

This endpoint allows you to get the detailed results of a Bank Document Verification

path Parameters

bank_document_verification_id

required

string (BankDocumentVerificationId) ^bdv_\w+$

Example: bdv_tkoi5db4hryu5cei5vwoabr7we

Bank Document Verification unique identifier.

Responses

Response samples

200

Content type

application/json

{"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"id": "bdv_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [{"code": 10000,
"summary": "string"
}
],
"risk_labels": ["multiple_faces_detected"
],
"bank_document": {"bank_account_number": "string",
"bank_routing_number": "string",
"account_type": "checking",
"company_name": "string",
"bank_name": "string",
"issue_date": "2019-08-24",
"document_type": "bank_statement",
"company_address": {"address_line1": "string",
"address_line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "US"
}
},
"_links": {"self": {"href": "http://example.com"
}
},
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"webhook_url": "http://example.com",
"declared_data": {"registered_name": "string",
"trading_name": "string"
}
}

Anonymize a Bank Document Verification

Anonymize the personal data of a Bank Document Verification with the specified ID.

path Parameters

bank_document_verification_id

required

string

ID of the document verification to anonymize

Responses

Response samples

200

Content type

application/json

{"id": "bdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

List Bank Document Verification attempts

This endpoint allows you to list all attempts of a Bank Document Verification.

Attempts are returned ordered by creation date, newest first.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

bank_document_verification_id

required

string

ID of the document verification

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 2,
"skip": 10,
"limit": 10,
"data": [{"id": "bdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123"
}
}
}
],
"_links": {"self": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts"
},
"next": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
},
"previous": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
}
}
}

Create a Bank Document Verification attempt

This endpoint allows you to create a Bank Document Verification attempt. It is possible when the Bank Document Verification is one of the following statuses: created, retry_required

path Parameters

bank_document_verification_id

required

string

ID of the document verification

Request Body schema: multipart/form-data
required

document

required

string <binary>

Responses

Request samples

Payload

Content type

multipart/form-data

Example

bank_document_verification_attempt_creation_request_body_min

{
  "document": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…\n"
}

Response samples

201

Content type

application/json

{"id": "bdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123"
}
}
}

Retrieve a Bank Document Verification attempt

This endpoint allows you to retrieve the details for a given Bank Document Verification attempt.

path Parameters

bank_document_verification_id required	string ID of the document verification
attempt_id required	string ID of the document verification attempt

Responses

Response samples

200

Content type

application/json

{"id": "bdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123"
}
}
}

Retrieve a Bank Document Verification attempt asset

This endpoint allows you to retrieve the assets associated with a Bank Document Verification. This includes the document image.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

bank_document_verification_id required	string ID of the Bank Document Verification
attempt_id required	string ID of the Bank Document Verification attempt

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 1,
"skip": 10,
"limit": 10,
"_links": {"self": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets"
},
"next": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets/..."
},
"previous": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets/..."
}
},
"data": [{"type": "document",
"_links": {"asset_url": {"href": "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets/document"
}
}
}
]
}

Request webhook notification

This endpoint can be used to initiate a webhook call containing the latest event of a Bank Document Verification

path Parameters

bank_document_verification_id

required

string

ID of the document verification to notify

Request Body schema: application/json

webhook_url

string <uri>

Responses

Request samples

Payload

Content type

application/json

{"webhook_url": "http://example.com"
}

Retrieve PDF report of a Bank Document Verification

This endpoint allows you to retrieve a PDF report of a Bank Document Verification.

Please note that the PDF report is only available for bank document verifications that are in status declined and approved once you receive the bank_document_verification_report_created event.

path Parameters

bank_document_verification_id

required

string

ID of the Bank Document Verification

Responses

Response samples

200

Content type

application/json

{"pdf_report": "https://www.example.com/reports/bdv_123.pdf"
}

Company document verifications (Coming soon)

Create a Company Document Verification

Creates a Company Document Verification

Request Body schema: application/json
required

user_journey_id required	string^usj_\w+$ User journey unique identifier.
applicant_id required	string^bplt_\w+$ Business Applicant unique identifier.
webhook_url	string <uri>
	object (CompanyDocumentVerificationDeclaredData)

Responses

Request samples

Payload

Content type

application/json

Example

company_document_verification_creation_request_body_min

{"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"declared_data": {"registered_name": "Acme Corporation"
}
}

Response samples

201

Content type

application/json

{"id": "cdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"declared_data": {"registered_name": "Acme Corporation"
},
"company_document": {"company_number": "12-3456789",
"registered_name": "Acme Corporation",
"legal_address": {"address_line1": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US"
},
"issue_date": "2023-01-15",
"registration_date": "2020-05-10",
"document_type": "ein_letter"
},
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve a Company Document Verification

This endpoint allows you to get the detailed results of a Company Document Verification

path Parameters

company_document_verification_id

required

string (CompanyDocumentVerificationId) ^cdv_\w+$

Example: cdv_tkoi5db4hryu5cei5vwoabr7we

Company Document Verification unique identifier.

Responses

Response samples

200

Content type

application/json

{"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"id": "cdv_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [{"code": 10000,
"summary": "string"
}
],
"risk_labels": ["multiple_faces_detected"
],
"company_document": {"company_number": "string",
"company_name": "string",
"registered_address": {"address_line1": "string",
"address_line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "US"
},
"issue_date": "2019-08-24",
"registration_date": "2019-08-24",
"document_type": "ein_letter"
},
"_links": {"self": {"href": "http://example.com"
}
},
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"webhook_url": "http://example.com",
"declared_data": {"registered_name": "string"
}
}

Anonymize a Company Document Verification

Anonymize the personal data of a Company Document Verification with the specified ID.

path Parameters

company_document_verification_id

required

string

ID of the document verification to anonymize

Responses

Response samples

200

Content type

application/json

{"id": "cdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "bplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

List Company Document Verification attempts

This endpoint allows you to list all attempts of a Company Document Verification.

Attempts are returned ordered by creation date, newest first.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

company_document_verification_id

required

string

ID of the document verification

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 2,
"skip": 10,
"limit": 10,
"data": [{"id": "cdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123"
}
}
}
],
"_links": {"self": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts"
},
"next": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
},
"previous": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
}
}
}

Create a Company Document Verification attempt

This endpoint allows you to create a Company Document Verification attempt. It is possible when the Company Document Verification is one of the following statuses: created, retry_required

path Parameters

company_document_verification_id

required

string

ID of the document verification

Request Body schema: multipart/form-data
required

document

required

string <binary>

Responses

Request samples

Payload

Content type

multipart/form-data

Example

company_document_verification_attempt_creation_request_body_min

{
  "document": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…\n"
}

Response samples

201

Content type

application/json

{"id": "cdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123"
}
}
}

Retrieve a Company Document Verification attempt

This endpoint allows you to retrieve the details for a given Company Document Verification attempt.

path Parameters

company_document_verification_id required	string ID of the document verification
attempt_id required	string ID of the document verification attempt

Responses

Response samples

200

Content type

application/json

{"id": "cdv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123"
}
}
}

Retrieve a Company Document Verification attempt asset

This endpoint allows you to retrieve the assets associated with a Company Document Verification. This includes the document image.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

company_document_verification_id required	string ID of the Company Document Verification
attempt_id required	string ID of the Company Document Verification attempt

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 1,
"skip": 10,
"limit": 10,
"_links": {"self": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets"
},
"next": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets/..."
},
"previous": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets/..."
}
},
"data": [{"type": "document",
"_links": {"asset_url": {"href": "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets/document"
}
}
}
]
}

Request webhook notification

This endpoint can be used to initiate a webhook call containing the latest event of a Company Document Verification

path Parameters

company_document_verification_id

required

string

ID of the document verification to notify

Request Body schema: application/json

webhook_url

string <uri>

Responses

Request samples

Payload

Content type

application/json

{"webhook_url": "http://example.com"
}

Retrieve PDF report of a Company Document Verification

This endpoint allows you to retrieve a PDF report of a Company Document Verification.

Please note that the PDF report is only available for company document verifications that are in status declined and approved once you receive the company_document_verification_report_created event.

path Parameters

company_document_verification_id

required

string

ID of the Company Document Verification

Responses

Response samples

200

Content type

application/json

{"pdf_report": "https://www.example.com/reports/cdv_123.pdf"
}

Address document verifications (Coming soon)

Create an Address Document Verification

Creates an Address Document Verification

Request Body schema: application/json
required

user_journey_id required	string^usj_\w+$ User journey unique identifier.
applicant_id required	string^aplt_\w+$ Applicant unique identifier.
webhook_url	string <uri>
	object (DeclaredData)

Responses

Request samples

Payload

Content type

application/json

Example

address_document_verification_creation_request_body_min

{"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"declared_data": {"name": "Acme Corporation"
}
}

Response samples

201

Content type

application/json

{"id": "adv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"declared_data": {"name": "Acme Corporation"
},
"address_document": {"type": "Utility Bill",
"full_name": "Acme Corporation",
"address": {"address_line1": "123 Main St",
"address_line2": "Suite 100",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US"
},
"issue_date": "2023-01-15"
},
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

Retrieve an Address Document Verification

This endpoint allows you to get the detailed results of an Address Document Verification

path Parameters

address_document_verification_id

required

string (AddressDocumentVerificationId) ^adv_\w+$

Example: adv_tkoi5db4hryu5cei5vwoabr7we

Address Document Verification unique identifier.

Responses

Response samples

200

Content type

application/json

{"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"id": "adv_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [{"code": 10000,
"summary": "string"
}
],
"risk_labels": ["multiple_faces_detected"
],
"address_document": {"document_type": "string",
"issuer": "string",
"full_names": ["string"
],
"address": {"address_line1": "string",
"address_line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "US"
},
"issue_date": "2019-08-24"
},
"_links": {"self": {"href": "http://example.com"
}
},
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"webhook_url": "http://example.com",
"declared_data": {"name": "string",
"birth_date": "2019-08-24"
}
}

Anonymize an Address Document Verification

Anonymize the personal data of an Address Document Verification with the specified ID.

path Parameters

address_document_verification_id

required

string

ID of the document verification to anonymize

Responses

Response samples

200

Content type

application/json

{"id": "adv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
"status": "created",
"response_codes": [ ],
"webhook_url": "https://my.api/events/",
"_links": {"self": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we"
}
}
}

List Address Document Verification attempts

This endpoint allows you to list all attempts of an Address Document Verification.

Attempts are returned ordered by creation date, newest first.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

address_document_verification_id

required

string

ID of the document verification

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 2,
"skip": 10,
"limit": 10,
"data": [{"id": "adv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123"
}
}
}
],
"_links": {"self": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts"
},
"next": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
},
"previous": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
}
}
}

Create an Address Document Verification attempt

This endpoint allows you to create an Address Document Verification attempt. It is possible when the Address Document Verification is one of the following statuses: created, retry_required

path Parameters

address_document_verification_id

required

string

ID of the document verification

Request Body schema: multipart/form-data
required

document

required

string <binary>

Responses

Request samples

Payload

Content type

multipart/form-data

Example

address_document_verification_attempt_creation_request_body_min

{
  "document": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…\n"
}

Response samples

201

Content type

application/json

{"id": "adv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123"
}
}
}

Retrieve an Address Document Verification attempt

This endpoint allows you to retrieve the details for a given Address Document Verification attempt.

path Parameters

address_document_verification_id required	string ID of the document verification
attempt_id required	string ID of the document verification attempt

Responses

Response samples

200

Content type

application/json

{"id": "adv_tkoi5db4hryu5cei5vwoabr7we",
"created_on": "2017-07-21T17:32:28Z",
"modified_on": "2017-07-21T17:40:32Z",
"status": "completed",
"response_codes": [ ],
"_links": {"self": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123"
}
}
}

Retrieve an Address Document Verification attempt asset

This endpoint allows you to retrieve the assets associated with an Address Document Verification. This includes the document image.

The response is paginated (see Pagination section). You can navigate through pages using the skip and limit query parameters or by following the URLs in the _links object.

path Parameters

address_document_verification_id required	string ID of the Address Document Verification
attempt_id required	string ID of the Address Document Verification attempt

query Parameters

skip	integer >= 0 Default: 0 Number of items to skip (offset)
limit	integer >= 1 Default: 10 Maximum number of items to return per page

Responses

Response samples

200

Content type

application/json

{"total_count": 1,
"skip": 10,
"limit": 10,
"_links": {"self": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123/assets"
},
"next": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123/assets/..."
},
"previous": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123/assets/..."
}
},
"data": [{"type": "document",
"_links": {"asset_url": {"href": "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123/assets/document"
}
}
}
]
}

Request webhook notification

This endpoint can be used to initiate a webhook call containing the latest event of an Address Document Verification

path Parameters

address_document_verification_id

required

string

ID of the document verification to notify

Request Body schema: application/json

webhook_url

string <uri>

Responses

Request samples

Payload

Content type

application/json

{"webhook_url": "http://example.com"
}

Retrieve PDF report of an Address Document Verification

This endpoint allows you to retrieve a PDF report of an Address Document Verification.

Please note that the PDF report is only available for address document verifications that are in status declined and approved once you receive the address_document_verification_report_created event.

path Parameters

address_document_verification_id

required

string

ID of the Address Document Verification

Responses

Response samples

200

Content type

application/json

{"pdf_report": "https://www.example.com/reports/adv_123.pdf"
}

Service status

Retrieve API health

This endpoint allows you to get the health of our api, anything other than a 200 status code is not OK

Checkout.com - Identity Verification (1.0.0)

Applicants

Create an Applicant

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve an Applicant

path Parameters

Responses

Response samples

Update an Applicant

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Anonymize an Applicant

path Parameters

Responses

Response samples

Business applicants

Create a Business Applicant

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve a Business Applicant

path Parameters

Responses

Response samples

Identity verifications

Create and start an identity verification

Request Body schema: application/jsonrequired

Responses

Callbacks

Request samples

Response samples

Callback payload samples

Create an identity verification

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve an identity verification

path Parameters

Responses

Response samples

Anonymize an identity verification

path Parameters

Responses

Response samples

List attempts

path Parameters

query Parameters

Responses

Response samples

Create an attempt

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve an attempt

path Parameters

Responses

Response samples

Retrieve attempt assets

path Parameters

query Parameters

Responses

Response samples

Request webhook notification

path Parameters

Request Body schema: application/json

Responses

Request samples

Retrieve PDF report of an identity verification

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required