KYB V2 API - PreviewOrganizations

Organization Ownership

Process a request for ownership details of an organization

Headers

api_keystringRequired
api_keystringRequired
Your API key provided by FrankieOne
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

forceRefreshbooleanOptional
This will fetch the latest information from the registry if set to true.

Request

This endpoint expects an object.
externalReferenceslist of objectsOptional
organizationTokenstringOptional
This is the unique Frankie token that contains all the information required from lookup that are needed in succeeding steps
organizationRegistrationobjectOptional

Response

Accepted
requestIdstring or null
The unique request identifier for the API call made.
entityIdstring or null

Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as 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.

Errors