Skip to main content
Create an Organization
curl --request POST \
  --url http://127.0.0.1:3000/v1/organizations \
  --header 'Content-Type: <content-type>' \
  --data '{
  "legalName": "Horizon Financial Group Ltd.",
  "doingBusinessAs": "HorizonPay",
  "legalDocument": "45891234000189",
  "status": {
    "code": "ACTIVE",
    "description": "Organization is fully verified and operational."
  },
  "address": {
    "line1": "742 Evergreen Plaza",
    "line2": "Suite 1203",
    "zipCode": 2118,
    "city": "Boston",
    "state": "Massachusetts",
    "country": "US"
  },
  "metadata": {
    "segment": "fintech",
    "riskTier": "low",
    "registrationSource": "onboarding-portal"
  }
}'
{
  "id": "cc15194a-6bc9-4ebb-b15d-43411a54ba4b",
  "parentOrganizationId": null,
  "legalName": "Empresa Teste Ltda",
  "doingBusinessAs": "Empresa Teste",
  "legalDocument": "86820799000188",
  "address": {
    "line1": "Rua Botucatu, 10",
    "line2": "Casa B",
    "zipCode": "04023060",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "status": {
    "code": "ACTIVE",
    "description": null
  },
  "createdAt": "2024-02-08T16:59:31+0300",
  "updatedAt": "2024-02-08T16:59:31+0300",
  "deletedAt": null
}
The parentOrganizationId field is optional. Use it to link an Organization to a “parent” by providing the parent Organization’s identifier.Leave this field empty if there is no parent.

Headers

​
Content-Type
string
required

The type of media of the resource. Must be application/json.

​
Authorization
string

The authorization token. This header is required if your environment has the Access Manager enabled.

​
X-Request-Id
string

A unique identifier used to trace and track each request.

Body

application/json
​
legalName
string
required

The legal name of the Organization.

Maximum length: 256
​
legalDocument
string
required

The document of the Organization.

Maximum length: 256
​
address
object
required

An object containing information about the address of the Organization.

​
parentOrganizationId
string<uuid> | null

The unique identifier of the parent Organization.

​
doingBusinessAs
string | null

The trade name of the Organization.

Maximum length: 256
​
status
object

An object containing information about the status. Important: If not provided, the default status will be 'ACTIVE'.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Response

Indicates that the resource was successfully created and the operation was completed as expected.

​
id
string<uuid>

The unique identifier of the Organization.

​
legalName
string

The legal name of the Organization.

Maximum length: 256
​
parentOrganizationId
string<uuid> | null

The unique identifier of the parent Organization.

​
doingBusinessAs
string | null

The trade name of the Organization.

Maximum length: 256
​
legalDocument
string

The document of the Organization.

Maximum length: 256
​
status
object

An object containing information about the status.

​
address
object

An object containing information about the address of the Organization.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Timestamp of creation (UTC).

​
updatedAt
string<date-time>

Timestamp of last update (UTC).

​
deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).