projects.apps.assessments
Overview
The Assessments API allows you to create and retrieve lending assessments tied to existing app user accounts such as borrowers.
Fields
Field | Data Type | Description |
accountId | string | Required
Unique id that identifies an account type and account id. The pattern is For example a borrower with a Read-only after creation |
assessmentId | string | Required Used in responses only A string that uniquely identifies an assessment within the lending app. Read-only after creation |
assessmentType | string | Required The full resource name of the assessment type. You can view all the available types of assessments using the assessmentTypes.list API method. Read-only |
timestamp | string ( Timestamp format ) | Required The assessment timestamp as captured on your lending app in ISO format. This field also determines the assessment evaluation window. For example, a timestamp from today evaluates account data up to today while a timestamp from a month ago evaluates account data up to a month ago. The evaluation window only goes as far back as 90 days for most assessments. Example: Read-only after creation |
status | number | Assessment status. The values are described below. 0 - not processed 1 - processed successfully 2 - processed with errors Read-only |
result | object ( AssessmentOutcome ) | null | Used in responses only The assessment outcome. It’s set to null on creation of the assessment and is populated with the outcome after the assessment it processed. Read-only |
appVersionId | string | The lending app Example: Read-only |
List
GET
https://lending.wezaapis.com/v1/projects/{projectId}/apps/{appId}/assessments
List all lending assessments for a lending app.
Path Parameters
Name | Type | Description |
---|---|---|
projectId | string | Id of the weza.io project |
appId | string | Id of the lending app |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer token |
Request Body
The request body should be empty.
Response Body
If successful, the response will contain data with the following structure.
Fields
Field | Data Type | Description |
assessments[] | object(LendingAssessment) | A list of lending assessment instances. |
nextPageToken | string | Token to use to fetch the next page of data if any. |
Authorization
Requires one of the following OAuth scopes:
platform.lending
platform.lending:read
The authenticated user must have the lending.assessments.list
permission.
Create
POST
https://lending.wezaapis.com/v1/projects/{projectId}/apps/{appId}/assessments
Create a lending assessment if one doesn't exist.
Path Parameters
Name | Type | Description |
---|---|---|
appId | string | Id of the lending app |
projectId | string | Id of the weza.io project |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer token |
Request Body
The request body contains an instance of LendingAssessment.
Response Body
The response body contains a new instance of LendingAssessment.
Authorization
Requires one of the following OAuth scopes:
platform.lending
platform.lending:write
The authenticated user must have the lending.assessments.create
permission.
Get
GET
https://lending.wezaapis.com/v1/projects/{projectId}/apps/{appId}/assessments/{assessmentId}
Retrieve a lending assessment by id.
Path Parameters
Name | Type | Description |
---|---|---|
projectId | string | Id of the weza.io project |
appId | string | Id of the lending app |
assessmentId | string |
|
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer token |
Response Body
The response body contains an instance of LendingAssessment.
Authorization
Requires one of the following OAuth scopes:
platform.lending
platform.lending:read
The authenticated user must have the lending.assessments.get
permission.
Last updated