VerificationPipeline

Retrieve verification pipeline configuration

get

Authorizations

Query parameters

accountIdstringRequired

Account ID to retrieve the verification pipeline for

Responses

200

Successfully retrieved verification pipeline configuration

application/json

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /verificationPipeline?accountId=text HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "ClientId": "",
  "EvictionCheck": true,
  "IncomeCheck": true,
  "SoftCreditCheck": true,
  "CriminalBackgroundCheck": true,
  "CountryIdentifier": "USA"
}

Add or update verification pipeline configuration

post

Authorizations

Body

ClientIdstringOptional

Client ID for the verification pipeline

EvictionCheckbooleanOptional

Indicates if eviction check is required

Example: true

IncomeCheckbooleanOptional

Indicates if income check is required

Example: true

SoftCreditCheckbooleanOptional

Indicates if soft credit check is required

Example: true

CriminalBackgroundCheckbooleanOptional

Indicates if criminal background check is required

Example: true

CountryIdentifierstringOptional

Country identifier for the verification pipeline

Example: USA

Responses

200

Successfully added or updated verification pipeline

text/plain

ResponsestringExample: Success

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /verificationPipeline HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "ClientId": "",
  "EvictionCheck": true,
  "IncomeCheck": true,
  "SoftCreditCheck": true,
  "CriminalBackgroundCheck": true,
  "CountryIdentifier": "USA"
}

Success