Skip to main content
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 '
{
  "type": "document-submission",
  "input": {
    "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:00.000Z"
  }
}
'
{
  "proofOfAddress": {
    "code": "proof-of-address",
    "status": "ok",
    "type": "document-submission",
    "verification": {
      "model": "partner-verified",
      "method": "manual",
      "dependencies": [
        "phone",
        "profile",
        "address"
      ],
      "submittable": false
    },
    "input": {
      "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:00.000Z"
    }
  }
}
Update proof-of-address is the endpoint through which the user proves their declared address of residence.

​
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.
A document that proves the user’s address of residence.File Category: document (which allows pdf files as well as typical images content-types)
Files are created and uploaded using the Create File endpoint.

​
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 address of residence against public and third-party records, such as government, credit, banking, and utility records.

​
Verification rejection reasons

When the process completes with status: failed, output.reason indicates why the verification was rejected:
  • address-mismatch: the submitted document does not match the declared address.
  • name-mismatch: the name on the submitted document does not match the user’s profile.
  • provider-verification-rejected: the upstream provider rejected the submission. When present, output.providerDetails.reasons[] carries provider-specific codes that can be surfaced to the user.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
​
type
enum<string>
required

The proof-of-address submission type.

Available options:
document-submission
​
input
object
required

Input of the KYC process.

​
output
object

Output of the KYC process.

Response

KYC proof-of-address process updated.

​
proofOfAddress
None · object
required