Pular para o conteúdo principal
PATCH
/
v1
/
organizations
/
{organization_id}
Atualizar uma Organização
curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id} \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "legalName": "Horizon Financial Group Ltd.",
  "doingBusinessAs": "HorizonPay",
  "legalDocument": "45891234000189",
  "status": {
    "code": "BLOCKED",
    "description": "Organization access temporarily suspended pending compliance review."
  },
  "address": {
    "line1": "Avenida Paulista, 1234",
    "line2": "Conjunto 203",
    "zipCode": "04696-040",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "metadata": {
    "onboardingStatus": "under_review",
    "vertical": "payments",
    "riskTier": "high",
    "suspendedBy": "compliance-system",
    "flags": {
      "amlCheck": "pending",
      "fraudAlert": true
    },
    "audit": {
      "updatedBy": "system",
      "lastAction": "Account flagged for enhanced due diligence"
    }
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legalName": "<string>",
  "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "doingBusinessAs": "<string>",
  "legalDocument": "<string>",
  "status": "<unknown>",
  "address": {
    "line1": "<string>",
    "zipCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "line2": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Cabeçalhos

​
Authorization
string

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

​
Content-Type
string
obrigatório

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

​
X-Request-Id
string<uuid>

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

Parâmetros de caminho

​
organization_id
string
obrigatório

O identificador único da Organização associada ao Ledger.

Corpo

application/json
​
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
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 a requisição foi bem-sucedida e a resposta contém os dados esperados.

​
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).