KYC V2 APIIndividual Documents

Get all documents for an entity

Get all documents for an entity.

Path parameters

entityIdstringRequired
Unique FrankieOne identifier for an entity

Headers

api_keystringRequired
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.

X-Frankie-UsernamestringOptional
Username provided by API caller

Query parameters

levelenumOptionalDefaults to meta

Determines what level of detail to return in the response

  • id: Return just an id
  • meta: Return all metadata only, no links or base64 data
  • base64: Return all metadata and data in base64 format
Allowed values:

Response

OK
REPORTlist of objects or null
SUPPORTINGlist of objects or null
IDENTITYlist of objects or null
OTHERlist of objects or null

Errors