Skip to main content
GET
/
v1
/
entities
/
{entityId}
Get
curl --request GET \
  --url https://api.cadanapay.com/v1/entities/{entityId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "37ad8c1e-0187-4e10-8c54-395e3385b4d2",
  "tenantKey": "cad617152",
  "legalName": "Acme Corp Ghana",
  "country": "GH",
  "currency": "GHS",
  "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",
  "entityType": "corporation",
  "status": "ACTIVE",
  "createdTimestamp": 1609459200,
  "lastUpdatedTimestamp": 1609459200
}

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.

Path Parameters

​
entityId
string<uuid>
required

The unique identifier of the entity

Response

Entity details

Full entity details

​
id
string<uuid>
Example:

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

​
tenantKey
string
Example:

"cad617152"

​
legalName
string
Example:

"Acme Corp Ghana"

​
country
string

ISO 3166-1 alpha-2 country code

Example:

"GH"

​
currency
string

ISO 4217 currency code

Example:

"GHS"

​
address
object

Address

​
phoneNumber
object

Person's phone number

​
registrationNumber
string
Example:

"BN-123456"

​
taxId
string
Example:

"TIN-789012"

​
incorporationDate
string
Example:

"2020-01-15"

​
entityType
enum<string>
Available options:
corporation,
c-corporation,
s-corporation,
partnership,
sole proprietorship,
limited liability company,
non profit,
other
Example:

"corporation"

​
status
string
Example:

"ACTIVE"

​
createdTimestamp
integer

Unix timestamp when the entity was created

Example:

1609459200

​
lastUpdatedTimestamp
integer

Unix timestamp when the entity was last updated

Example:

1609459200