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": "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"
    }
  }
}

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.

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.

Deposit Type	Electronic verification	Document submission
Card deposits	Enough for FCA registered firms	Enough
Bank deposits	Not enough	Enough
Crypto deposits	Not enough	Enough

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.

Show child attributes

input.media

object[]

required

The media that was used to verify the process.

Required array length: 1 - 10 elements

Show child attributes

input.media.context

enum<string>

required

The context of the file.

Available options:

photo-document-front,

photo-document-back,

photo-selfie,

photo-selfie-and-document-front,

video

input.media.fileId

string<uuid>

required

The id of the file.

output

object

Output of the KYC process.

Show child attributes

output.provider

string

required

The provider used to verify the KYC process.

output.document

object

required

The identity document information.

Show child attributes

output.document.type

enum<string>

required

The type of the document.

Available options:

driving-license,

id-card,

passport,

residence-permit

output.document.number

string

required

The number of the document.

output.document.country

string

required

The country of the document.

output.document.expiresAt

string<date>

The expiration date of the document.

output.person

object

required

The person information.

Show child attributes

output.person.givenName

string

required

The person's given name.

Maximum string length: 200

output.person.birthdate

string<date>

required

The date of birth.

output.person.familyName

string

The person's family name or surname.

Maximum string length: 200

output.person.gender

enum<string>

The gender.

Available options:

female,

male

output.person.address

object

The address information.

Show child attributes

output.person.address.country

string

required

The country of the address.

output.person.address.subdivision

string

The subdivision of the address.

output.person.address.city

string

The city of the address.

output.person.address.line1

string

The first line of the address.

output.person.address.line2

string

The second line of the address.

output.person.address.postalCode

string

The postal code of the address.

output.verifiedAt

string<date-time>

required

The date and time of the verification.

Response

KYC identity process updated.

identity

None · object

required

None
Document submission
Electronic verification

Show child attributes

identity.status

enum<string>

required

Status of the KYC process.

Available options:

ok,

failed,

running,

pending,

exempt

identity.type

enum<string>

The identity submission type.

Available options:

none

Update address Update proof of address

⌘I

Core API

Topper API

Widgets API

Update identity

Via document submission

Via electronic verification (e-IDV)

When to use document submission verification vs electronic verification

Authorizations

Body

Response

Core API

Topper API

Widgets API

​Via document submission

​Via electronic verification (e-IDV)

​When to use document submission verification vs electronic verification

Authorizations

Body

Response

Via document submission

Via electronic verification (e-IDV)

When to use document submission verification vs electronic verification