KYB V2 APIReports

Report Request

This is a Frankie-made report based on the current information available for the entity ID.

Reports include:

  • profile
  • ownership

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.

Query parameters

reportTypeenumRequired

Specifies the report you wish to run.

Allowed values:

Response

Accepted

requestIdstring

The unique request ID for the API call made.

reportIdstringOptional

The unique identifier for the requested report

hrefstringOptional

Errors