Consumer Level Lending
put

/account/{checkoutToken}/{accountToken}

You must connect with an FNPL account before accessing this endpoint. In this endpoint you can update account personal or status information.

Authorization

apiKey - Authorization

Request Parameters

2 Path Parameters
1 Header

Request Body

Schema
object

Provide fields that need updating only, if you wish to unset a value, provide a string of value {unset} against the key you want to unset and information will be removed.

By providing the firstNames, middleNames and lastNames, the fullName key will be auto-generated at the API level. However, if you give the fullName key, you should not provide the individual parts as the API level will attempt to split the fullName into their designated parts and overwrite any parts given by you.

gender
integer
Code Description
101 Female
102 Male
fullName
string
1 validation
firstNames
string
1 validation
middleNames
string
1 validation
lastNames
string
1 validation
dob
string

YYYY-MM-DD Date of birth

1 validation
resident
integer
Code Description
100 Other Tenant
101 Owner
102 Tenant Unfurnished
103 Council Tenant
104 House Share
105 Living With Parents
106 Tenant Furnished
employment
integer
Code Description
100 Other
101 Full Time Employment
102 Part Time Employment
103 Self Employed
104 Not Employed
105 Student
106 Homemaker
107 Retired
salary
integer
1 validation
salaryCurrency
string

ISO-4217 currency code

mobileCountry
string

ISO-3166-1 alpha-2 country code

mobileNumber
string

The phone number without international or local prefixes

bankAccountNumber
string
bankSortCode
string
marital
integer
Code Description
100 Single
101 Married
102 Cohabiting
103 Engaged
104 Widowed
105 Divorced
106 Separated
dependents
integer
1 validation
useSavings
boolean
1 validation
socialSecurityNumber
string

Responses

In case of a success, the API will provide the status code, no content is expected.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
checkoutToken
accountToken
$$.env
1 variable not set
Authorization