Skip to main content
POST
/
v2
/
organizations
/
ownership
Organization Ownership
curl --request POST \
  --url https://api.frankie.one/v2/organizations/ownership \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "organizationToken": "<string>",
  "organizationRegistration": {
    "region": {
      "country": "<string>",
      "subdivision": "<string>"
    },
    "organizationNumbers": [
      {
        "registrationNumber": "<string>",
        "registryCode": "<string>"
      }
    ]
  },
  "externalReferences": [
    {
      "name": "CUSTOMER-REFERENCE",
      "value": "CUST-00001342",
      "description": "This is the customer ID in the core banking system."
    }
  ]
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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.

Query Parameters

​
forceRefresh
boolean

This will fetch the latest information from the registry if set to true.

Body

application/json
​
organizationToken
string

This is the unique Frankie token that contains all the information required from lookup that are needed in succeeding steps

​
organizationRegistration
object
​
externalReferences
object[]

Response

Accepted

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
entityId
string

Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"