Skip to main content
PATCH
/
core
/
kyc
/
processes
/
identity
curl --request PATCH \
  --url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/identity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "document-submission",
  "input": {
    "media": [
      {
        "context": "photo-selfie",
        "fileId": "470b2192-893f-4ce6-9daa-816d4c319a84"
      }
    ]
  },
  "output": {
    "provider": "veriff",
    "document": {
      "type": "passport",
      "number": "7700225VH",
      "country": "GB",
      "expiresAt": "2026-03-13"
    },
    "person": {
      "givenName": "John",
      "familyName": "Doe",
      "birthdate": "1987-01-01",
      "gender": "male"
    },
    "verifiedAt": "2020-01-01T00:00:00Z"
  }
}'
{
  "identity": {
    "status": "ok",
    "type": "document-submission",
    "input": {
      "media": [
        {
          "context": "photo-document-front",
          "fileId": "75e5be00-4264-4cec-ace6-598bff79932c"
        },
        {
          "context": "photo-document-back",
          "fileId": "402587f2-6299-4a40-b465-eb49d739998c"
        },
        {
          "context": "photo-selfie",
          "fileId": "470b2192-893f-4ce6-9daa-816d4c319a84"
        }
      ]
    },
    "output": {
      "provider": "veriff",
      "document": {
        "type": "passport",
        "number": "7700225VH",
        "country": "GB",
        "expiresAt": "2026-03-13"
      },
      "person": {
        "givenName": "John",
        "familyName": "Doe",
        "birthdate": "1987-01-01",
        "gender": "male",
        "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 Update identity endpoint is used for verifying that a user is who they claim to be.
Identity verification can be done in two ways:

​
Via document submission

The user must provide actual ID documents (e.g., passport, ID card) and biometrics (e.g., selfie) to prove their identity. There are media files required for the identity verification process that must be passed as input.media. The following table lists the supported contexts and their respective file categories.
The front side of the photo document.File Category: document (which allows pdf files as well as typical images content-types)
The back side of the photo document.File Category: document (which allows pdf files as well as typical images content-types)
A selfie of the user.File Category: image
A selfie of the user holding the photo document.File Category: image
A recording of the user going through the process of taking pictures.File Category: video
Files are created and uploaded using the Create File endpoint.

​
Via electronic verification (e-IDV)

Some KYC providers allow for identity verification through electronic means, i.e., submission of documents is not provided. This is usually done by checking the user’s declared information against public and third-party records, such as government, credit, banking, and utility records.
e-IDV must be explicitly requested through your assigned Account Manager and approved by Uphold’s Compliance team before it can be enabled.

​
When to use document submission verification vs electronic verification

The table below indicates whether each method is adequate for proving user identity.
Deposit TypeElectronic verificationDocument submission
Card depositsEnough for FCA registered firmsEnough
Bank depositsNot enoughEnough
Crypto depositsNot enoughEnough

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
  • Document submission
  • Electronic verification
​
type
enum<string>
required

The identity submission type.

Available options:
document-submission
​
input
object
required

Input of the KYC process.

​
output
object

Output of the KYC process.

Response

KYC identity process updated.

​
identity
object
required
  • None
  • Document submission
  • Electronic verification