Skip to main content
POST
/
v1
/
entities
Create
curl --request POST \
  --url https://api.cadanapay.com/v1/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "legalName": "Acme Corp Ghana",
  "country": "GH",
  "currency": "GHS",
  "entityType": "corporation",
  "address": {
    "countryCode": "US",
    "line1": "Street 1",
    "line2": "Apt 1",
    "city": "Gotham",
    "postalCode": "10001",
    "state": "NY"
  },
  "phoneNumber": {
    "countryCode": "1",
    "number": "2345678901"
  },
  "registrationNumber": "BN-123456",
  "taxId": "TIN-789012",
  "incorporationDate": "2020-01-15"
}
'
{
  "id": "37ad8c1e-0187-4e10-8c54-395e3385b4d2"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Body

application/json

Create entity request payload

​
legalName
string
required

Legal name of the entity

Example:

"Acme Corp Ghana"

​
country
string
required

ISO 3166-1 alpha-2 country code

Example:

"GH"

​
currency
string
required

ISO 4217 currency code

Example:

"GHS"

​
entityType
enum<string>

Legal structure type

Available options:
corporation,
c-corporation,
s-corporation,
partnership,
sole proprietorship,
limited liability company,
non profit,
other
Example:

"corporation"

​
address
object

Address

​
phoneNumber
object

Person's phone number

​
registrationNumber
string

Business registration number

Example:

"BN-123456"

​
taxId
string

Tax identification number

Example:

"TIN-789012"

​
incorporationDate
string

Date of incorporation (YYYY-MM-DD)

Example:

"2020-01-15"

Response

Entity created

Create entity response

​
id
string<uuid>

The unique identifier of the created entity

Example:

"37ad8c1e-0187-4e10-8c54-395e3385b4d2"