v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

affordability

Request affordability calculation for a user

Requires affordability:write and affordability:read scopes.

post/affordability

Request body

externalUserIdstring

Your reference ID for the user or individual affordability application. The same value could be assigned to all reports created as part of the same affordability application's lifecycle, for example

namestring

The full name of the user to whom the affordability application applies

emailstring

The email address of the user to whom the affordability application applies

Example request

{
  "externalUserId": "LENDERNAME-123",
  "name": "Joe Bloggs",
  "email": "joe.blogss@example.com"
}

Response

Successful Affordability Response

metaobject