VerificationPipeline
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
GET /verificationPipeline?accountId=text HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"ClientId": "",
"EvictionCheck": true,
"IncomeCheck": true,
"SoftCreditCheck": true,
"CriminalBackgroundCheck": true,
"CountryIdentifier": "USA"
}
Authorizations
Body
ClientIdstringOptional
Client ID for the verification pipeline
EvictionCheckbooleanOptionalExample:
Indicates if eviction check is required
true
IncomeCheckbooleanOptionalExample:
Indicates if income check is required
true
SoftCreditCheckbooleanOptionalExample:
Indicates if soft credit check is required
true
CriminalBackgroundCheckbooleanOptionalExample:
Indicates if criminal background check is required
true
CountryIdentifierstringOptionalExample:
Country identifier for the verification pipeline
USA
Responses
200
Successfully added or updated verification pipeline
text/plain
ResponsestringExample:
Success
500
Internal server error
post
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