KYB V2 Experimental APIOrganization

Document Analyze

Begin a Document Analysis

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
entityIdstringOptional

Entity’s are assigned an auto-generated UUID to ensure global uniqueness, represented as an entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request call.

documentIdstringOptionalformat: "uuid"
As documents are added to an entity, they're assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request call.
analysisTypeenumOptional
The type of document analysis to perform
Allowed values:
supplementaryInformationobjectOptional

Response

Accepted
entityIdstring or null

Entity’s are assigned an auto-generated UUID to ensure global uniqueness, represented as an entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request call.

analysisobject or null
requestIdstring or null
The unique request ID for the API call made.

Errors