Create an individual entity

POST

Creates an Individual entity object which can be used to store data about an individual. You can optionally include documents, attachments, references etc. to the entity. Information stored in an entity object can be used to verify the individual against external data sources for the purposes of eKYC, or in other verifications supported by FrankieOne.

Headers

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: idmetabase64

Request

This endpoint expects an object.
individualobjectOptional
serviceNamestringOptional
workflowNamestringOptional
commentobjectOptional

Response

Created

requestIdstring

The unique request ID for the API call made.

individualobjectOptional
serviceProfileslist of objectsOptional
Get an individual entity
Built with