How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Uphold Veriff API

Veriff KYC Connector.

Uphold Veriff API is one of 25 APIs that Uphold publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Veriff. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a changelog.

This API exposes 5 operations across 3 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 2 base URLs: https://api.enterprise.sandbox.uphold.com, https://api.enterprise.uphold.com.

5 operations 3 paths 25 schemas 3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.enterprise.uphold.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Uphold Veriff API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 6 scopes. By default, every request must be authenticated.

  • OAuth2 — OAuth 2.0 authentication

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Veriff 5

Veriff KYC Connector.

POST
/kyc-connector/veriff/ingestions
Create Veriff ingestion
kyc-connector.create-veriff-ingestion 7 params body → 201401403409429
GET
/kyc-connector/veriff/ingestions
List Veriff ingestions
kyc-connector.list-veriff-ingestions 8 params → 200401403429
GET
/kyc-connector/veriff/ingestions/{ingestionId}
Get Veriff ingestion
kyc-connector.get-veriff-ingestion 8 params → 200400401403404429
PUT
/kyc-connector/veriff/config
Set Veriff config
kyc-connector.set-veriff-config 1 param body → 200400401403429
GET
/kyc-connector/veriff/config
Get Veriff config
kyc-connector.get-veriff-config 1 param → 200401403404429

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are ingestion (11 properties), address (6 properties), ingestion-result-process-error (5 properties), ingestion-result-profile-data (4 properties). Each schema is shown below with its type and property counts.

webhook-event
object
The webhook event information.
4 properties 4 required
veriff-session-for-request
object
A Veriff session for creating an ingestion.
3 properties 2 required
ingestion-result-profile-data
object
The extracted profile data.
4 properties
ingestion-result-address-data
veriff-ingestion-process
string
feedback
object
A feedback message with a code and human-readable description.
3 properties 2 required
veriff-integration-config-for-request
object
A Veriff integration configuration for creating or updating provider config.
4 properties 2 required
veriff-ingestion-result-process-error
pagination
object
The pagination information.
3 properties
address
object
The address information.
6 properties
veriff-ingestion-webhook-event
string-no-edge-spaces
string
error
The error information.
ingestion-result-process-files
array
The list of files downloaded during ingestion related to the process.
ingestion-result-process-error
object
The error information associated with the process.
5 properties
veriff-session
object
A Veriff session used for data ingestion.
3 properties 3 required
veriff-integration-config
object
A Veriff integration configuration.
4 properties 2 required
ingestion-result-process-status
string
The status associated with the process.
ingestion-result-identity-data
object
The extracted identity data.
3 properties
subdivision-code-for-request
string
ingestion
object
11 properties 8 required
veriff-ingestion
country-code-for-request
string
veriff-provider-config
object
The Veriff provider configuration.
3 properties 3 required
ingestion-result-proof-of-address-data
object
The extracted proof-of-address data.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

uphold-veriff-api-openapi.yml Raw ↑

Other APIs Uphold publishes across the network.

Uphold Public API (v0)
Uphold Documentation MCP Server
Uphold Accounts API
Uphold Assets API
Uphold Authentication API
Uphold Capabilities API
Uphold Countries API
Uphold External accounts API
Uphold Files API
Uphold General API
Uphold Ingestions API
Uphold KYB API
Where this information came from

This is an independent, third-party profile of Uphold Veriff API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.