Skip to main content
PATCH
/
core
/
kyc
/
processes
/
address
Update 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": "GB-MAN",
      "city": "Manchester",
      "line1": "1 High Street",
      "line2": "Northern Quarter",
      "postalCode": "M4 1AA"
    }
  }
}
'
{
  "address": {
    "code": "address",
    "status": "ok",
    "verification": {
      "model": "uphold-verified",
      "method": "manual",
      "dependencies": []
    },
    "input": {
      "address": {
        "country": "GB",
        "subdivision": "GB-MAN",
        "city": "Manchester",
        "line1": "1 High Street",
        "line2": "Northern Quarter",
        "postalCode": "M4 1AA"
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.uphold.com/llms.txt

Use this file to discover all available pages before exploring further.

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

The subdivision field is only accepted in the request if both of the following conditions are met:
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

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
​
input
object
required

Input of the KYC process.

Response

KYC address process updated.

​
address
object
required

The KYC address object.