Skip to main content
POST
Create an individual entity

Authorizations

api_key
string
header
required

Headers

api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

X-Frankie-Channel
string

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-Username
string

Username provided by API caller

Example:

"fred.flintstone@frankieone.com"

Query Parameters

level
enum<string>
default: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
Available options:
id,
meta,
base64

Body

application/json

Create an individual

individual
object
serviceName
string
workflowName
string
comment
object

Response

Created

requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

individual
object
serviceProfiles
object[]