Update 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": "driving-license",
      "number": "D1234567",
      "country": "US",
      "expiresAt": "2026-03-13"
    },
    "person": {
      "givenName": "John",
      "familyName": "Doe",
      "birthdate": "1987-01-01",
      "gender": "male"
    },
    "verifiedAt": "2020-01-01T00:00:00.000Z"
  }
}
'

{
  "identity": {
    "code": "identity",
    "status": "ok",
    "type": "document-submission",
    "verification": {
      "model": "partner-verified",
      "method": "manual",
      "dependencies": [
        "phone",
        "profile"
      ],
      "submittable": true
    },
    "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": "driving-license",
        "number": "D1234567",
        "country": "US",
        "expiresAt": "2026-03-13"
      },
      "person": {
        "givenName": "John",
        "familyName": "Doe",
        "birthdate": "1987-01-01",
        "gender": "male",
        "address": {
          "country": "US",
          "subdivision": "US-CA",
          "city": "Los Angeles",
          "line1": "100 Main Street",
          "postalCode": "90011"
        }
      },
      "verifiedAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

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": "driving-license",
      "number": "D1234567",
      "country": "US",
      "expiresAt": "2026-03-13"
    },
    "person": {
      "givenName": "John",
      "familyName": "Doe",
      "birthdate": "1987-01-01",
      "gender": "male"
    },
    "verifiedAt": "2020-01-01T00:00:00.000Z"
  }
}
'

{
  "identity": {
    "code": "identity",
    "status": "ok",
    "type": "document-submission",
    "verification": {
      "model": "partner-verified",
      "method": "manual",
      "dependencies": [
        "phone",
        "profile"
      ],
      "submittable": true
    },
    "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": "driving-license",
        "number": "D1234567",
        "country": "US",
        "expiresAt": "2026-03-13"
      },
      "person": {
        "givenName": "John",
        "familyName": "Doe",
        "birthdate": "1987-01-01",
        "gender": "male",
        "address": {
          "country": "US",
          "subdivision": "US-CA",
          "city": "Los Angeles",
          "line1": "100 Main Street",
          "postalCode": "90011"
        }
      },
      "verifiedAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

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.

photo-document-front

The front side of the photo document.File Category: document (which allows pdf files as well as typical images content-types)

photo-document-back

The back side of the photo document.File Category: document (which allows pdf files as well as typical images content-types)

photo-selfie

A selfie of the user.File Category: image

photo-selfie-and-document-front

A selfie of the user holding the photo document.File Category: image

video

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 from 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.

Transfer type	Electronic verification	Document submission
Card deposits	Enough for FCA registered firms	Enough
Bank deposits	Not enough	Enough
Bank withdrawals	Not enough	Enough
Crypto deposits	Not enough	Enough
Crypto withdrawals	Not enough	Enough

Verification rejection reasons

When the process completes with status: failed, output.reason indicates why the verification was rejected:

data-mismatch: the submitted data does not match the document.
duplicate: the document or identity is already associated with another user.
underage: the user does not meet the minimum age requirement.
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

Document submission
Electronic verification

type

enum<string>

required

The identity submission type.

Available options:

document-submission

input

object

Input of the KYC process.

Show child attributes

output

object

Output of the KYC process.

Show child attributes

Response

KYC identity process updated.

identity

None · object

required

The KYC identity object.

None
Document submission
Electronic verification

Show child attributes

warnings

object

The warnings generated during a process update.

Show child attributes

Core API

Trading API

Market Pulse API

KYC Connector API

Widgets API

Topper API

Update identity

Via document submission

Via electronic verification (e-IDV)

When to use document submission verification vs electronic verification

Verification rejection reasons

Authorizations

Body

Response

​Via document submission

​Via electronic verification (e-IDV)

​When to use document submission verification vs electronic verification

​Verification rejection reasons

Authorizations

Body

Response

Via document submission

Via electronic verification (e-IDV)

When to use document submission verification vs electronic verification

Verification rejection reasons