KYB V2.1 API - PreviewOrganizations

Create an organization entity

Creates an Organization entity object which can be used to store data about an organization. You can optionally include documents, attachments, references etc. to the entity.

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.

X-Frankie-UsernamestringOptional
Username provided by API caller

Request

Organization token retrieved with the lookup.
organizationTokenstringRequired
serviceNamestringOptional
commentobjectOptional

Response

Created
requestIdstring
The unique request identifier for the API call made.
organizationobject or null
This is the complete Organization Model
serviceProfileslist of objects or null

Errors