Consumer Level Lending
post

/account/{checkoutToken}/{accountToken}/address

Please note, the provided addresses will be checked against address database, if we fail to identify the address it will not be saved.

Authorization

apiKey - Authorization

Request Parameters

2 Path Parameters
1 Header

Request Body

Schema
object

Each address corresponds to an address type, when creating the very first address within its address type, it will automatically become the primary address within that address type, the provided primary will be ignored in that case. When setting an address as primary, any addresses within the same address type will lose their primary state.

addressToken
string

addressToken

1 validation + required
primary
boolean

Specifies if the address is primary within the address type of the address.

required
type
integer
Code Description
100 Other Address
101 Residential Address
102 Billing Address
103 Office Address
104 Shipping Address
required
floor
string
apartment
string
house
string
street
string
city
string
county
string
state
string
postcode
string
country
string

ISO-3166-1 alpha-2 country code

summary
object

Provides information on how to display the address information

Responses

Status 200

Schema
object
addressToken
string
1 validation + required

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