Pular para o conteúdo principal
POST
/
v1
/
organizations
Criar uma Organização
curl --request POST \
  --url https://ledger.sandbox.lerian.net/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": "Avenida Paulista, 1234",
    "line2": "Conjunto 203",
    "zipCode": "04696-040",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "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
}

Cabeçalhos

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

​
Authorization
string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver o Access Manager habilitado.

​
X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Corpo

application/json
​
legalName
string
obrigatório

A razão social da Organização.

Maximum string length: 256
​
legalDocument
string
obrigatório

O documento da Organização.

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

O identificador único da Organização pai.

​
doingBusinessAs
string | null

O nome fantasia da Organização.

Maximum string length: 256
​
status
object

Um objeto contendo informações sobre o status. Importante: Se não fornecido, o status padrão será 'ACTIVE'.

​
address
object

Um objeto contendo informações sobre o endereço da Organização.

​
metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

​
id
string<uuid>

O identificador único da Organização.

​
legalName
string

A razão social da Organização.

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

O identificador único da Organização pai.

​
doingBusinessAs
string | null

O nome fantasia da Organização.

Maximum string length: 256
​
legalDocument
string

O documento da Organização.

Maximum string length: 256
​
status
any
​
address
object

Um objeto contendo informações sobre o endereço da Organização.

​
metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Data e hora de criação (UTC).

​
updatedAt
string<date-time>

Data e hora da última atualização (UTC).

​
deletedAt
string<date-time> | null

Data e hora da exclusão lógica, se aplicável (UTC).