PATCH
/
core
/
kyc
/
processes
/
proof-of-address
curl --request PATCH \
  --url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/proof-of-address \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "input": {
    "type": "electronic-verification"
  },
  "output": {
    "provider": "sumsub",
    "person": {
      "givenName": "John",
      "familyName": "Doe",
      "address": {
        "country": "GB",
        "subdivision": "GB-MAN",
        "city": "Manchester",
        "line1": "1 High Street",
        "line2": "Northern Quarter",
        "postalCode": "M4 1AA"
      }
    },
    "verifiedAt": "2020-01-01T00:00:00Z"
  }
}'
{
  "proofOfAddress": {
    "status": "ok",
    "input": {
      "type": "document-submission",
      "media": [
        {
          "context": "address-proof",
          "fileId": "459c0447-8916-4bad-bb67-f2354fcfb10b"
        }
      ]
    },
    "output": {
      "provider": "sumsub",
      "person": {
        "givenName": "John",
        "familyName": "Doe",
        "address": {
          "country": "GB",
          "subdivision": "GB-MAN",
          "city": "Manchester",
          "line1": "1 High Street",
          "line2": "Northern Quarter",
          "postalCode": "M4 1AA"
        }
      },
      "verifiedAt": "2020-01-01T00:00:00Z"
    }
  }
}

The proof-of-address is a process where the user proves their declared address of residency.

​
Via electronic verification

Some KYC providers allow for address verification through electronic means, without requiring providing any documents.

They usually do this by checking the user’s declared residency address against public and third-party records, such as government, credit, banking, and utility records.

​
Via document submission

If electronic verification is not possible, the user must provide a document to prove their address, usually by providing a utility bill or bank statement. The document is provided as a media file, passed in input.media. At this time, only a single media file is supported for this process.

Files are created and uploaded using the Create File endpoint.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
​
input
object
required

Input of the KYC process.

​
output
object

Output of the KYC process.

Response

200
application/json
KYC proof of address process updated.
​
proofOfAddress
object
required