Skip to main content
POST
/
v2
/
customers
Create a child customer account
curl --request POST \
  --url https://api.uat.frankie.one/v2/customers \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "customer": {
    "name": "Example Child Account"
  },
  "defaultWorkflows": [
    {
      "workflowDefinitionId": "customer-verification-workflow",
      "workflowName": "<string>",
      "workflowDisplayName": "<string>",
      "workflowDefinitionVersion": "0",
      "lifecyclePhase": "OTHER"
    }
  ],
  "initialUsers": [
    {
      "name": "Jane Doe",
      "email": "user@example.com",
      "roles": [
        1
      ]
    }
  ],
  "additionalConfigurations": {
    "white_label_portal": {
      "brandName": "Acme",
      "primaryColor": "#FF6600"
    }
  },
  "externalReferences": [
    {
      "name": "CUSTOMER-REFERENCE",
      "value": "CUST-00001342",
      "description": "This is the customer ID in the core banking system.",
      "type": "CUSTOMER",
      "metadata": {}
    }
  ]
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "customer": {
    "name": "Example Child Account",
    "customerChildId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "defaultWorkflows": [
    {
      "workflowDefinitionId": "customer-verification-workflow",
      "workflowName": "<string>",
      "workflowDisplayName": "<string>",
      "workflowDefinitionVersion": "0",
      "lifecyclePhase": "OTHER"
    }
  ],
  "initialUsers": [
    {
      "name": "Jane Doe",
      "email": "user@example.com",
      "roles": [
        1
      ]
    }
  ],
  "additionalConfigurations": {
    "white_label_portal": {
      "brandName": "Acme",
      "primaryColor": "#FF6600"
    }
  },
  "externalReferences": [
    {
      "name": "CUSTOMER-REFERENCE",
      "value": "CUST-00001342",
      "description": "This is the customer ID in the core banking system.",
      "type": "CUSTOMER",
      "metadata": {}
    }
  ]
}

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-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"

Body

application/json

Request to create a child customer account in the context of the calling account as the parent.

​
customer
object
required

A child customer account in the context of the calling account as the parent.

​
defaultWorkflows
object[]

Workflows that will be configured for the child customer by default.

​
initialUsers
object[]

Optional list of users to provision in the newly created child customer account. Each user will be invited via the supplied email address.

​
additionalConfigurations
object

Optional map of additional configurations to apply to the child customer, keyed by namespace (e.g. white_label_portal). The number of entries is variable - callers may supply zero, one, or many namespaces. Each value is the raw configuration payload for that namespace and is stored as-is.

Example:
{
  "white_label_portal": {
    "brandName": "Acme",
    "primaryColor": "#FF6600"
  }
}
​
externalReferences
object[]

Optional list of external references to associate with the child customer.

Response

Child customer account successfully created.

Response object for creating a child customer account.

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
customer
object

A child customer account in the context of the calling account as the parent.

​
defaultWorkflows
object[]

The workflows that have been configured for the child customer.

​
initialUsers
object[]

The users that have been provisioned in the newly created child customer account.

​
additionalConfigurations
object

The additional configurations that have been applied to the child customer, keyed by namespace (e.g. white_label_portal). The number of entries returned reflects what was supplied on create.

Example:
{
  "white_label_portal": {
    "brandName": "Acme",
    "primaryColor": "#FF6600"
  }
}
​
externalReferences
object[]

The external references that have been associated with the child customer.