assessmentTypes

Overview

The AssessmentTypes API allows you to view information on all types of assessments available to lending apps.

JSON representation

"assessmentTypeId": string,
"category": string,
"period": string,
"status": number,
"displayName": string,
"settings": object(AssessmentSettings) | null,
"description": string | null

Fields

Field	Data Type	Description
assessmentTypeId	string	Required Unique string that identifies the assessment type. Read-only after creation
category	string ( 'credit', 'loan' )	Required The assessment category. Read-only after creation
period	string	Required The assessment evaluation period description. Example: '30 days' Read-only after creation
status	number	Required The assessment status. The values are enumerated below. 0: In beta testing 1: General availability/live 2: Deprecated Read-only
displayName	string	Required The assessment's display name. Read-write
description	string | null	Required The assessment's description. Read-write
settings	object ( AssessmentSettings ) | null	Required The assessment's settings. Read-only

List

GET https://lending.wezaapis.com/v1/assessmentTypes

Lists all default assessment types available on the lending service.

Query Parameters

Name	Type	Description
pageSize	integer	Requested size of the next page of data.
pageToken	string	Token specifying the start of the next page. It is returned by the previous response.

Headers

Name	Type	Description
Authorization	string	Bearer token.

200

{
    "assessmentTypes": [
        {
            "uid": "fc68fda6-01be-5432-8d18-4a168c23cb2e",
            "name": "assessmentTypes/personal_credit_standard",
            "status": 1,
            "createdAt": "2020-06-28T16:53:00.261Z",
            "assessmentTypeId": "personal_credit_standard",
            "category": "credit",
            "period": "90 days",
            "displayName": "Standard Personal Credit Assessment",
            "description": "Individual borrower credit assessment with a risk evaluation.",
            "settings": {
                "apps": {
                    "channels": [
                        "mobile"
                    ],
                    "platforms": [
                        "android"
                    ]
                },
                "accounts": {
                    "categories": [
                        "individual"
                    ],
                    "accountTypes": [
                        "borrower"
                    ]
                }
            }
        }
    ],
    "nextPageToken": null
}

Request Body

The request body should be empty.

Response Body

If successful, the response will contain data with the following structure.

JSON Representation

{
  "assessmentTypes": [
    {
      object(AssessmentType)
    }
  ],
  "nextPageToken": string,
}

Fields

Field	Data Type	Description
assessmentTypes[]	object(AssessmentType)	A list of assessment type instances.
nextPageToken	string	Token to use to fetch the next page of data if any.

Authorization

Requires any one of the following OAuth scopes:

• platform

• platform.lending

• platform.lending:read

The authenticated user must have the lending.assessmentTypes.list permission.