Update email

Update the email process for an individual user.

PATCH /core/kyc/processes/email

cURL

Update Process

curl --request PATCH \
  --url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "email": "[e-mail]"
  }
}
'

200

Process Updated

{
  "email": {
    "code": "email",
    "status": "pending",
    "verification": {
      "model": "partner-verified",
      "method": "manual",
      "dependencies": []
    },
    "input": {
      "email": "[e-mail]"
    }
  }
}

Update email is the endpoint through which the user registers their email address.

Submitting input on its own registers the email as unverified (pending). Include output.verifiedAt to mark it ok immediately, or submit it in a later call to verify an existing pending registration. See verification models for details.

Authorizations

Authorization · string · header · required

OAuth 2.0 authentication.

Body

application/json

input · object · required

Input of the KYC process.

Show child attributes

output · object

Output of the KYC process.

Show child attributes

Response

200

application/json

KYC email process updated.

email · object · required

The KYC email object.

Show child attributes

warnings · object

The warnings generated during a process update.

Show child attributes