KYB

Get overview

Get the KYB overview of a business user.

get/core/kyb

Request

Base URL
https://api.enterprise.sandbox.uphold.com
Auth
OAuth 2
Client credentials
Token URL/core/oauth2/token
Scopescore.kyb:read
TypeScript
https://skmtc.dev/uphold/apis/core-api/docs/core/kyb/get.ts
A function with typed inputs. Its response is checked against the schema.

detailedstring[]

Include detailed information about the specified KYB processes. Use this sparingly as its more expensive to retrieve.

X-On-Behalf-Ofstring

The subject on whose behalf the operation is being performed.

string ipv4

string ipv6

Contains the IP of the end user that is requesting the operation.

X-Uphold-User-Agentstring

Contains the user agent of the end user that is requesting the operation.

X-Uphold-User-Originstring

Contains the origin of the request made by the end user.

X-Uphold-User-Countrystring

Contains the code of the country of the end user that is requesting the operation.

X-Uphold-User-Subdivisionstring

Contains the code of the subdivision of the end user that is requesting the operation.

X-Uphold-User-Citystring

Contains the name of the city of the end user that is requesting the operation.

KYB overview retrieved.

No recorded changes to this operation across all 1 revision of this API.