UPP Docs
Compliance

Get a verification

GET
/customer-verifications/{verificationId}

Status and outcome of a verification by its ID. Identity data is not included.

Authorization

merchantApiKeymerchantTimestampmerchantNoncemerchantSignature
headerX-API-KEY<token>

Merchant API key (starts with upk_, also accepts api-key); signing headers are also required

headerX-Timestamp<token>

Unix timestamp in seconds, within 300 seconds of server time

headerX-Nonce<token>

Unique per request; cannot be reused with the same credential during the timestamp validity window

headerX-Signature<token>

Hex HMAC-SHA256 signature (either letter case) of the method, full path, timestamp, nonce and body digest

Path Parameters

verificationId*string

Verification ID (starts with cvr_)

Response Body

Verification

application/json
  1. response
id*string

Verification ID (starts with cvr_)

customer_id*string

Customer ID (starts with cus_)

usage*VerificationUsage

Verification usage, which determines the provider that runs it. The usage must be enabled for the merchant (configured by UPP; test is off by default, the others are on):

usageNotes
testDevelopment and testing only
basicReturns a hosted verification link
kycPart of the profile flow: also creates the profile; contact_email is required when the customer has no email; the result has no document images
bank_accountUsed before applying for virtual accounts at some banks: required when the virtual_account profile's document is not an ID card or passport; start it after the virtual_account profile is approved, otherwise 422; the result has no document images
Value in"test""basic""kyc""bank_account"
status*CustomerVerificationStatus

pending waiting for the customer or the review, approved approved, rejected rejected

Value in"pending""approved""rejected"
rejection_reason*|

Rejection reason, only when rejected

verified_at*|

Approval time, only when approved

Formatdate-time
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X GET 'https://sandbox.getupp.net/api/v1/customer-verifications/string'
Example Response
{  "id": "cvr_01m5eadct0b1padtfy5g1h9z1w",  "customer_id": "cus_01m5ead2k7knsqfa65tpt1an6r",  "usage": "test",  "status": "approved",  "rejection_reason": null,  "verified_at": "2026-10-21T04:09:51.000000Z",  "created_at": "2026-10-21T04:09:51.000000Z",  "updated_at": "2026-10-21T04:09:51.000000Z"}