Skip to main content
POST
Update Physical Address

Overview

Submit user’s physical residential address. This is required for KYC verification and compliance purposes. For US residents, you can optionally specify a separate mailing address. For non-US residents, mailing address must be the same as physical address.

Request

Body

string
required
Onboarding ID from previous step
string
required
Primary address lineExample: 23 Werrington Bridge Rd
string
Secondary address line (optional)Example: Milking Nook
string
required
City nameExample: Peterborough
string
required
Postal/ZIP codeExample: PE6 7PP
string
US state postal abbreviationRequired only if: countryOfResidence = USExample: CA
boolean
required
Whether mailing address is same as physicalMust be true unless: countryOfResidence = USExample: true

Response

string
Access token (only if registration complete)Returned when isSameMailingAddress = true OR non-US residentExample: US_100a99cf-f4d3-4fa1-c321-2e9833440ebb
string
Updated onboarding ID
object
Updated user object with address

Code Examples

If accessToken is returned, registration is complete. Otherwise, proceed to mailing address step (US only).

Next Steps

Update Mailing Address

Add mailing address (US residents only)