UBubble
Address document verifications (Coming soon)

Create an Address Document Verification

Creates an Address Document Verification

post/v2/address-document-verifications

Request

Request body

user_journey_idstring

User journey unique identifier.

applicant_idstring

Applicant unique identifier.

webhook_urlstring uri

Example request

{
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we"
}

Response

Address Document Verification created successfully

idstring

Address Document Verification unique identifier.

status'created' | 'quality_checks_in_progress' | 'checks_in_progress' | 'approved' | 'declined' | 'retry_required' | 'inconclusive'

Address Document Verification status.

risk_labelsRiskLabel[]

Risk assessment labels

user_journey_idstring

User journey unique identifier.

applicant_idstring

Applicant unique identifier.

webhook_urlstring uri
created_onstring date-time required

UTC Date time when the resource was created

modified_onstring date-time required

UTC Date time when the resource was modified

Example response

{
  "id": "adv_tkoi5db4hryu5cei5vwoabr7we",
  "address_document": {
    "address": {
      "country": "US"
    }
  },
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2017-07-21T17:32:28Z",
  "modified_on": "2017-07-21T17:40:32Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.