Peach Finance

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 verification types—i.e., the question bank.

Securityoauth2 or bearerAuth or apiKeyHeader
Responses
200

Success

get/verification-questions
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Create verification type

Create a new borrower verification type.

This represents one configuration of how to perform borrower verifications. Later, when starting a new borrower verification, you can then specify a particular verification type to use. This done by POST-ing to the /people/{personId}/verifications endpoint with a body like:

{
  "verificationTypeId": "VT-7RKX-OKQZ"
}

Using with CRM App UI

In order to specify that the CRM application should make use a particular verification type you must set the company config value: config.borrowerVerification.crmDefaultTypeId to the ID of the verification type ID of the verification type you wish to use.

e.g., config.borrowerVerification.crmDefaultTypeId = "VT-7RKX-OKQZ"

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
optional
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 or 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/verification-types
Request samples
application/json
{
  • "expirationInSecs": 900,
  • "maxSessionsRecentPast": 2,
  • "recentPastSecs": 3600,
  • "maxAttemptsPerSession": 3,
  • "enabledQuestionIds": [
    ],
  • "questionSelectionCriteria": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get verification types

Securityoauth2 or bearerAuth or apiKeyHeader
Request
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/verification-types
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Update verification type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
verificationTypeId
required
string

The unique borrower verification type identifier.

Request Body schema: application/json
optional
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 or 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/verification-types/{verificationTypeId}
Request samples
application/json
{
  • "expirationInSecs": 900,
  • "maxSessionsRecentPast": 2,
  • "recentPastSecs": 3600,
  • "maxAttemptsPerSession": 3,
  • "enabledQuestionIds": [
    ],
  • "questionSelectionCriteria": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get verification type by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
verificationTypeId
required
string

The unique borrower verification type identifier.

Responses
200

Success

get/verification-types/{verificationTypeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}
➔ Next to Campaign Overview