KYB V2.1 API - PreviewOrganization Workflows

Execute a workflow with organization details

Execute a workflow for the supplied organization details. If no matching organization is found for the provided details, a new organization will be created. The request body includes entityID, organizationToken and organization. Only one of these should be provided per request. Providing more than one will result in an error. Additionally you can also specify a serviceName to execute a workflow for a specific service profile of the organization.

Path parameters

workflowNamestringRequired

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-BackgroundenumOptional
If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See our callback API for details on this.
Allowed values:
X-Frankie-UsernamestringOptional
Username provided by API caller

Request

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

Defines the fields under organization object on which workflow is executed. The created/updated organization will then be updated with the details provided.

serviceNamestringOptional
Name of the service profile of the organization against which the workflow is to be executed. If no value is passed, default configured service name will be used.
commentobjectOptional

Response

Execution request completed
workflowResultobject or null
serviceProfileobject or null
organizationobject or null
Organization details at the current time. This could be different from the original organization details at the time of workflow execution.
requestIdstring or null
The unique request identifier for the API call made.

Errors