KYB V2 Experimental APIOrganization

Document Analyses Results

Get Document Analyses Results

Path parameters

documentIdstringRequired

Unique identifier for a document

entityIdstringRequired

Unique FrankieOne identifier for an entity

Headers

AuthorizationstringRequired

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

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

api_keystringRequired

Your API key provided by FrankieOne

Query parameters

showResultsenumOptionalDefaults to LATEST

Which types of results should be shown

Allowed values:

Response

OK

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.

analyseslist of objectsOptional
requestIdstringOptional

The unique request ID for the API call made.

Errors