curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"address": {
"subdivision": "US-CA",
"city": "Los Angeles",
"line1": "100 Main Street",
"postalCode": "90011"
}
}
}
'{
"address": {
"code": "address",
"status": "ok",
"verification": {
"model": "none",
"method": "manual",
"dependencies": []
},
"input": {
"address": {
"country": "US",
"subdivision": "US-CA",
"city": "Los Angeles",
"line1": "100 Main Street",
"postalCode": "90011"
}
}
}
}KYC
Update address
deprecated
Update the address process for an individual user.
PATCH
/
core
/
kyc
/
processes
/
address
curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"address": {
"subdivision": "US-CA",
"city": "Los Angeles",
"line1": "100 Main Street",
"postalCode": "90011"
}
}
}
'{
"address": {
"code": "address",
"status": "ok",
"verification": {
"model": "none",
"method": "manual",
"dependencies": []
},
"input": {
"address": {
"country": "US",
"subdivision": "US-CA",
"city": "Los Angeles",
"line1": "100 Main Street",
"postalCode": "90011"
}
}
}
}
Update address is the endpoint through which the user can update their address of residence.
This process solely updates the user’s address of residence. It does not perform any verification. For address verification, refer to the proof-of-address process.
Subdivision update requirements
Thesubdivision field is only accepted in the request if both of the following conditions are met:
- The proof-of-address process is
partner-verifiedfor your organization. - The
countryfield is not set toUS.
If the
subdivision field is provided without meeting the above conditions, the request is rejected with a 409 Conflict error — operation_not_allowed with subdivision-update-non-authoritative-proof-of-address (when proof-of-address is uphold-verified) or subdivision-update-restricted-by-residence-country (when country is US) in details.reasons.Authorizations
OAuth 2.0 authentication.
FlowClient Credentials
- Token URL
- /core/oauth2/token
Scopes1
core.kyc.address:update
Grants access to update address KYC process
Body
application/json
Input of the KYC process.
Show child attributes
Show child attributes
Response
KYC address process updated.
The KYC address object.
Show child attributes
Show child attributes
Was this page helpful?