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 '{
  "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-09-04",
      "gender": "male"
    },
    "verifiedAt": "2020-01-01T00:00:00Z"
  }
}'
{
  "identity": {
    "status": "ok",
    "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-09-04",
        "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 identity is a process where the user proves who they say they are, via an official document such as a government issued ID card or a passport. Moreover, the user may be susceptible to taking selfies to further check if the person on the document is the same as the one going through the process.

​
Media files

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.

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 identity process updated.
​
identity
object
required