Verification Types

This object represents configurations describing how new borrower verifications should behave.

Get questions

Retrieve all the questions which are available for use with this company's verification types—i.e., the question bank.

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

companyId

required

string

The unique company identifier.

Responses

200

Success

get/companies/{companyId}/verification-questions

Response samples

application/json

{"count": 0,
"data": [{"id": "string",
"text": "string",
"memo": "string",
"category": "inBorrowerPortal"
}
]
}

Create verification type

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

companyId

required

string

The unique company identifier.

Request Body schema: application/json

expirationInSecs	integer Default: 900 How many seconds each verification session has until it is marked as expired.
maxSessionsRecentPast	integer Default: 2 Throttles maximum verification sessions a borrower can initiate within "the recent past". Where recent past time length is configured via `recentPastSecs`.
recentPastSecs	integer Default: 3600 The number of seconds into the past which is considered the "recent past" for the purposes of throttling verifications. See: `maxSessionsRecentPast`.
maxAttemptsPerSession	integer Default: 3 The number of attempts to answer the verification questions a borrower is allowed.
enabledQuestionIds	Array of strings Default: null List of question IDs the system will consider when randomly selecting questions for verification; if `null` then all available questions will be considered. (See all available questions).
	Array of objects Object describing which and how many questions (at a minimum) to select at random. (Only questions with IDs present in `enabledQuestionIds` will be considered.)

Responses

200

Success

post/companies/{companyId}/verification-types

Request samples

Payload

application/json

{"expirationInSecs": 900,
"maxSessionsRecentPast": 2,
"recentPastSecs": 3600,
"maxAttemptsPerSession": 3,
"enabledQuestionIds": null,
"questionSelectionCriteria": [{"exactMatchCount": 0,
"category": "inBorrowerPortal"
}
]
}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"expirationInSecs": 900,
"maxSessionsRecentPast": 2,
"recentPastSecs": 3600,
"maxAttemptsPerSession": 3,
"enabledQuestionIds": null,
"questionSelectionCriteria": [{"exactMatchCount": 0,
"category": "inBorrowerPortal"
}
]
}
}

Get verification types

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

companyId

required

string

The unique company identifier.

query Parameters

limit	integer [ 1 .. 100 ] Default: 25 The maximum count of results to retrieve.
startingAfter	string Return results starting after the provided object identifier.
endingBefore	string Return results ending before the provided object identifier.

Responses

200

Success

get/companies/{companyId}/verification-types

Response samples

application/json

{"total": 0,
"count": 0,
"nextUrl": "string",
"previousUrl": "string",
"data": [{"id": "string",
"expirationInSecs": 900,
"maxSessionsRecentPast": 2,
"recentPastSecs": 3600,
"maxAttemptsPerSession": 3,
"enabledQuestionIds": null,
"questionSelectionCriteria": [{"exactMatchCount": 0,
"category": "inBorrowerPortal"
}
]
}
]
}

Update verification type

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

companyId required	string The unique company identifier.
verificationTypeId required	string The unique borrower verification type identifier.

Request Body schema: application/json

expirationInSecs	integer Default: 900 How many seconds each verification session has until it is marked as expired.
maxSessionsRecentPast	integer Default: 2 Throttles maximum verification sessions a borrower can initiate within "the recent past". Where recent past time length is configured via `recentPastSecs`.
recentPastSecs	integer Default: 3600 The number of seconds into the past which is considered the "recent past" for the purposes of throttling verifications. See: `maxSessionsRecentPast`.
maxAttemptsPerSession	integer Default: 3 The number of attempts to answer the verification questions a borrower is allowed.
enabledQuestionIds	Array of strings Default: null List of question IDs the system will consider when randomly selecting questions for verification; if `null` then all available questions will be considered. (See all available questions).
	Array of objects Object describing which and how many questions (at a minimum) to select at random. (Only questions with IDs present in `enabledQuestionIds` will be considered.)

Responses

200

Success

put/companies/{companyId}/verification-types/{verificationTypeId}

Request samples

Payload

application/json

{"expirationInSecs": 900,
"maxSessionsRecentPast": 2,
"recentPastSecs": 3600,
"maxAttemptsPerSession": 3,
"enabledQuestionIds": null,
"questionSelectionCriteria": [{"exactMatchCount": 0,
"category": "inBorrowerPortal"
}
]
}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"expirationInSecs": 900,
"maxSessionsRecentPast": 2,
"recentPastSecs": 3600,
"maxAttemptsPerSession": 3,
"enabledQuestionIds": null,
"questionSelectionCriteria": [{"exactMatchCount": 0,
"category": "inBorrowerPortal"
}
]
}
}

Get verification type by ID

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

companyId required	string The unique company identifier.
verificationTypeId required	string The unique borrower verification type identifier.

Responses

200

Success

get/companies/{companyId}/verification-types/{verificationTypeId}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"expirationInSecs": 900,
"maxSessionsRecentPast": 2,
"recentPastSecs": 3600,
"maxAttemptsPerSession": 3,
"enabledQuestionIds": null,
"questionSelectionCriteria": [{"exactMatchCount": 0,
"category": "inBorrowerPortal"
}
]
}
}

➔ Next to Campaign Overview