> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Trigger attestation
> Trigger the attestation process for a business user, initiating all verifications that will populate the attestation output.
export const RestEndpointSubjects = ({subjects = []}) => {
const subjectToIconMap = {
'client': 'browser',
'user:individual': 'user',
'user:business': 'briefcase'
};
if (subjects.length === 0) {
return null;
}
return <>
{subjects.map(subject =>
{subject}
)}
;
};
This endpoint is not yet available in **Sandbox** or **Production**.
**Trigger attestation** starts the final step of KYB, running every verification check over the information the business submitted.
More information will be supplied once this endpoint is complete.
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json post /core/kyb/processes/attestation/trigger
openapi: 3.1.0
info:
version: 0.1.0
title: Core API
description: >-
The Core API provides essential building blocks that empower businesses to
embed financial services into their applications.
contact:
name: Uphold API Team
email: developers@uphold.com
url: https://developer.uphold.com
servers:
- url: https://api.enterprise.sandbox.uphold.com
description: Sandbox
- url: https://api.enterprise.uphold.com
description: Production
security:
- OAuth2: []
tags:
- name: Authentication
description: Authentication.
- name: Countries
description: Countries.
- name: Users
description: Users.
- name: KYC
description: Individual User's KYC.
- name: KYB
description: Business User's KYB.
- name: Capabilities
description: User capabilities.
- name: Terms of service
description: User terms of service.
- name: Files
description: Files.
- name: Assets
description: Assets, networks and rails.
- name: Accounts
description: Accounts.
- name: External accounts
description: External accounts.
- name: Transactions
description: Transactions.
- name: Portfolio
description: Portfolio.
- name: Statements
description: Statements.
- name: Metadata
description: Metadata.
- name: Webhooks
description: Webhooks.
paths:
/core/kyb/processes/attestation/trigger:
post:
tags:
- KYB
summary: Trigger attestation
description: >-
Trigger the attestation process for a business user, initiating all
verifications that will populate the attestation output.
operationId: core.trigger-kyb-attestation
responses:
'200':
$ref: '#/components/responses/trigger-kyb-attestation-response'
'409':
$ref: '#/components/responses/trigger-kyb-attestation-conflict-response'
security:
- OAuth2:
- core.kyb.attestation:trigger
components:
responses:
trigger-kyb-attestation-response:
description: Attestation process triggered.
content:
application/json:
schema:
type: object
properties:
attestation:
$ref: '#/components/schemas/kyb-attestation'
required:
- attestation
examples:
Attestation Triggered:
value:
attestation:
code: attestation
status: running
output:
checks:
- code: business-online-presence
status: not-started
- code: business-classification
status: not-started
- code: business-registry
status: not-started
- code: business-registrations
status: not-started
- code: business-associated-persons
status: not-started
- code: business-adverse-media
status: not-started
- code: business-address-lookup
status: not-started
- code: business-tin-database
status: not-started
- code: business-screening
status: not-started
- code: business-documents
status: not-started
- code: licensing-verification
status: not-started
- code: associated-persons-screening
status: not-started
- code: associated-persons-address-lookup
status: not-started
- code: associated-persons-tin-database
status: not-started
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
trigger-kyb-attestation-conflict-response:
description: Business logic error.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Attestation Already Running:
value:
code: operation_not_allowed
message: Attestation process is already running
details:
reasons:
- attestation-already-running
KYB Prerequisites Not Met:
value:
code: operation_not_allowed
message: >-
KYB prerequisites must be completed before triggering
attestation
details:
reasons:
- kyb-profile-incomplete
- kyb-documents-incomplete
- kyb-associated-persons-incomplete
KYB Prerequisites Not Met (Financial Institution):
value:
code: operation_not_allowed
message: >-
KYB prerequisites must be completed before triggering
attestation
details:
reasons:
- kyb-profile-incomplete
- kyb-documents-incomplete
- kyb-associated-persons-incomplete
- kyb-financial-institution-incomplete
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
schemas:
kyb-attestation:
description: The KYB attestation object.
type: object
properties:
code:
description: The code of the KYB process.
type: string
const: attestation
status:
$ref: '#/components/schemas/kyb-process-status'
output:
type: object
description: Output of the KYB process.
properties:
checks:
description: The list of checks performed as part of the KYB attestation.
type: array
items:
oneOf:
- title: Business Online Presence
type: object
properties:
code:
type: string
const: business-online-presence
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Business Classification
type: object
properties:
code:
type: string
const: business-classification
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Business Registry
type: object
properties:
code:
type: string
const: business-registry
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Business Registrations
type: object
properties:
code:
type: string
const: business-registrations
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Business Associated Persons
type: object
properties:
code:
type: string
const: business-associated-persons
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Business Adverse Media
type: object
properties:
code:
type: string
const: business-adverse-media
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Business Address Lookup
type: object
properties:
code:
type: string
const: business-address-lookup
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Business TIN Database
type: object
properties:
code:
type: string
const: business-tin-database
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Business Screening
type: object
properties:
code:
type: string
const: business-screening
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Business Documents
type: object
properties:
code:
type: string
const: business-documents
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Licensing Verification
type: object
properties:
code:
type: string
const: licensing-verification
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Associated Persons Screening
type: object
properties:
code:
type: string
const: associated-persons-screening
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Associated Persons Address Lookup
type: object
properties:
code:
type: string
const: associated-persons-address-lookup
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
- title: Associated Persons TIN Database
type: object
properties:
code:
type: string
const: associated-persons-tin-database
status:
$ref: '#/components/schemas/kyb-attestation-check-status'
reason:
description: >-
The reason associated with the check's current status
(e.g., the reason for the `rejected` status).
type: string
note:
description: Any additional note related to the check result.
type: string
required:
- code
- status
required:
- checks
required:
- code
- status
error:
description: The error information.
allOf:
- $ref: '#/components/schemas/feedback'
kyb-process-status:
description: Status of the KYB process.
type: string
enum:
- ok
- failed
- running
- pending
- exempt
kyb-attestation-check-status:
description: The status of the check
type: string
enum:
- not-started
- skipped
- in-progress
- in-review
- approved
- rejected
feedback:
description: A feedback message with a code and human-readable description.
type: object
properties:
code:
description: A short string with a brief explanation about the code reported.
type: string
message:
description: A human-readable message providing more details.
type: string
details:
description: Additional information about the feedback reported.
type: object
additionalProperties: true
required:
- code
- message
securitySchemes:
OAuth2:
type: oauth2
description: OAuth 2.0 authentication.
flows:
clientCredentials:
tokenUrl: /core/oauth2/token
scopes:
core.users:act-on-behalf-of: Grants access to act on behalf of a user
core.users:create: Grants access to create users
core.users:read: Grants access to view users
core.users:delete: Grants access to delete users
core.users.metadata:read: Grants access to view user metadata
core.users.metadata:write: Grants access to modify user metadata
core.kyc:read: Grants access to view KYC processes
core.kyc.profile:update: Grants access to update profile KYC process
core.kyc.address:update: Grants access to update address KYC process
core.kyc.email:update: Grants access to update email KYC process
core.kyc.phone:update: Grants access to update phone KYC process
core.kyc.identity:update: Grants access to update identity KYC process
core.kyc.proof-of-address:update: Grants access to update proof-of-address KYC process
core.kyc.customer-due-diligence:update: Grants access to update customer due diligence KYC process
core.kyc.enhanced-due-diligence:update: Grants access to update enhanced due diligence KYC process
core.kyc.crypto-risk-assessment:update: Grants access to update crypto risk assessment KYC process
core.kyc.self-categorization-statement:update: Grants access to update self-categorization statement KYC process
core.kyc.tax-details:update: Grants access to update tax details KYC process
core.kyb:read: Grants access to view KYB processes
core.kyb.profile:update: Grants access to update profile KYB process
core.kyb.documents:update: Grants access to update documents KYB process
core.kyb.financial-institution:update: Grants access to update financial institution KYB process
core.kyb.associated-persons:create: Grants access to create KYB associated persons
core.kyb.associated-persons:read: Grants access to view KYB associated persons
core.kyb.associated-persons:delete: Grants access to delete KYB associated persons
core.kyb.associated-persons.profile:update: Grants access to update profile KYB associated person process
core.kyb.associated-persons.identity:update: Grants access to update identity KYB associated person process
core.kyb.associated-persons.proof-of-address:update: >-
Grants access to update proof-of-address KYB associated person
process
core.kyb.attestation:trigger: Grants access to trigger the attestation process
core.capabilities:read: Grants access to view user capabilities
core.terms-of-service:read: Grants access to view terms of service
core.terms-of-service:accept: Grants access to accept terms of service
core.files:create: Grants access to create files
core.files:read: Grants access to view files
core.files.metadata:read: Grants access to view files metadata
core.files.metadata:write: Grants access to modify files metadata
core.accounts:create: Grants access to create accounts
core.accounts:read: Grants access to view accounts
core.accounts:update: Grants access to update accounts
core.accounts:archive: Grants access to archive accounts
core.accounts:deposit-method: >-
Grants access to deposit method needed for depositing into
accounts
core.accounts:use-test-helpers: Grants access to test helpers of accounts
core.accounts.metadata:read: Grants access to view accounts metadata
core.accounts.metadata:write: Grants access to modify accounts metadata
core.assets:use-test-helpers: Grants access to test helpers of assets
core.external-accounts:create: Grants access to create external accounts
core.external-accounts:read: Grants access to view external accounts
core.external-accounts:update: Grants access to update external accounts
core.external-accounts:delete: Grants access to delete external accounts
core.external-accounts.metadata:read: Grants access to view external accounts metadata
core.external-accounts.metadata:write: Grants access to modify external accounts metadata
core.transactions:create: Grants access to commit quotes
core.transactions:read: Grants access to view transactions
core.transactions.metadata:read: Grants access to view transactions metadata
core.transactions.metadata:write: Grants access to modify transactions metadata
core.transactions.requests-for-information:read: Grants access to view transactions requests for information
core.transactions.requests-for-information:update: Grants access to update transactions requests for information
core.portfolio:read: >-
Grants access to view portfolio overview, performance, and
historical balance
core.statements:read: Grants access to read statements
core.webhooks:management-link: Grants access to create webhook management links
````