Skip to main content
PUT
Update KYC Address

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"651c1b87-f79e-4085-aca2-3a836f8c5b81"

Path Parameters

addressType
enum<string>
required

The type of address to update.

Available options:
residential,
mailing

Body

application/json

Request body for updating a user's address. Required fields: countryCode, city, address.

countryCode
string
required

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$
Example:

"US"

city
string
required

City name.

Maximum string length: 100
Example:

"New York"

address
string
required

Street address.

Maximum string length: 200
Example:

"123 Main Street"

stateCode
string

State/Province ISO code (e.g. US-NY, CA-ON). Required for countries with provinces/states.

Example:

"NY"

buildingNumber
string

Building/apartment number.

Maximum string length: 50
Example:

"Apt 4B"

zipCode
string

Postal/ZIP code.

Maximum string length: 20
Example:

"10001"

Response

Address updated successfully.

Response after updating a user's address.

success
boolean
Example:

true

data
object