Atualizar uma Organização

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "legalName": "Lerian Studio",
  "doingBusinessAs": "Lerian Studio",
  "status": {
    "code": "INACTIVE",
    "description": "Acesso à Organização temporariamente suspenso aguardando revisão de conformidade."
  },
  "address": {
    "line1": "Avenida Paulista, 1234 - Centro",
    "line2": "CJ 123",
    "zipCode": "04696040",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "metadata": {
    "onboardingStatus": "under_review",
    "vertical": "payments",
    "riskTier": "high",
    "suspendedBy": "compliance-system",
    "flagsAmlCheck": "pending",
    "flagsFraudAlert": true,
    "auditUpdatedBy": "system",
    "auditLastAction": "Account flagged for enhanced due diligence"
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{id}"

payload = {
    "legalName": "Lerian Studio",
    "doingBusinessAs": "Lerian Studio",
    "status": {
        "code": "INACTIVE",
        "description": "Acesso à Organização temporariamente suspenso aguardando revisão de conformidade."
    },
    "address": {
        "line1": "Avenida Paulista, 1234 - Centro",
        "line2": "CJ 123",
        "zipCode": "04696040",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR"
    },
    "metadata": {
        "onboardingStatus": "under_review",
        "vertical": "payments",
        "riskTier": "high",
        "suspendedBy": "compliance-system",
        "flagsAmlCheck": "pending",
        "flagsFraudAlert": True,
        "auditUpdatedBy": "system",
        "auditLastAction": "Account flagged for enhanced due diligence"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    legalName: 'Lerian Studio',
    doingBusinessAs: 'Lerian Studio',
    status: {
      code: 'INACTIVE',
      description: 'Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.'
    },
    address: {
      line1: 'Avenida Paulista, 1234 - Centro',
      line2: 'CJ 123',
      zipCode: '04696040',
      city: 'São Paulo',
      state: 'SP',
      country: 'BR'
    },
    metadata: {
      onboardingStatus: 'under_review',
      vertical: 'payments',
      riskTier: 'high',
      suspendedBy: 'compliance-system',
      flagsAmlCheck: 'pending',
      flagsFraudAlert: true,
      auditUpdatedBy: 'system',
      auditLastAction: 'Account flagged for enhanced due diligence'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'legalName' => 'Lerian Studio',
    'doingBusinessAs' => 'Lerian Studio',
    'status' => [
        'code' => 'INACTIVE',
        'description' => 'Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.'
    ],
    'address' => [
        'line1' => 'Avenida Paulista, 1234 - Centro',
        'line2' => 'CJ 123',
        'zipCode' => '04696040',
        'city' => 'São Paulo',
        'state' => 'SP',
        'country' => 'BR'
    ],
    'metadata' => [
        'onboardingStatus' => 'under_review',
        'vertical' => 'payments',
        'riskTier' => 'high',
        'suspendedBy' => 'compliance-system',
        'flagsAmlCheck' => 'pending',
        'flagsFraudAlert' => true,
        'auditUpdatedBy' => 'system',
        'auditLastAction' => 'Account flagged for enhanced due diligence'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{id}"

	payload := strings.NewReader("{\n  \"legalName\": \"Lerian Studio\",\n  \"doingBusinessAs\": \"Lerian Studio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.\"\n  },\n  \"address\": {\n    \"line1\": \"Avenida Paulista, 1234 - Centro\",\n    \"line2\": \"CJ 123\",\n    \"zipCode\": \"04696040\",\n    \"city\": \"São Paulo\",\n    \"state\": \"SP\",\n    \"country\": \"BR\"\n  },\n  \"metadata\": {\n    \"onboardingStatus\": \"under_review\",\n    \"vertical\": \"payments\",\n    \"riskTier\": \"high\",\n    \"suspendedBy\": \"compliance-system\",\n    \"flagsAmlCheck\": \"pending\",\n    \"flagsFraudAlert\": true,\n    \"auditUpdatedBy\": \"system\",\n    \"auditLastAction\": \"Account flagged for enhanced due diligence\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://ledger.sandbox.lerian.net/v1/organizations/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"legalName\": \"Lerian Studio\",\n  \"doingBusinessAs\": \"Lerian Studio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.\"\n  },\n  \"address\": {\n    \"line1\": \"Avenida Paulista, 1234 - Centro\",\n    \"line2\": \"CJ 123\",\n    \"zipCode\": \"04696040\",\n    \"city\": \"São Paulo\",\n    \"state\": \"SP\",\n    \"country\": \"BR\"\n  },\n  \"metadata\": {\n    \"onboardingStatus\": \"under_review\",\n    \"vertical\": \"payments\",\n    \"riskTier\": \"high\",\n    \"suspendedBy\": \"compliance-system\",\n    \"flagsAmlCheck\": \"pending\",\n    \"flagsFraudAlert\": true,\n    \"auditUpdatedBy\": \"system\",\n    \"auditLastAction\": \"Account flagged for enhanced due diligence\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"legalName\": \"Lerian Studio\",\n  \"doingBusinessAs\": \"Lerian Studio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.\"\n  },\n  \"address\": {\n    \"line1\": \"Avenida Paulista, 1234 - Centro\",\n    \"line2\": \"CJ 123\",\n    \"zipCode\": \"04696040\",\n    \"city\": \"São Paulo\",\n    \"state\": \"SP\",\n    \"country\": \"BR\"\n  },\n  \"metadata\": {\n    \"onboardingStatus\": \"under_review\",\n    \"vertical\": \"payments\",\n    \"riskTier\": \"high\",\n    \"suspendedBy\": \"compliance-system\",\n    \"flagsAmlCheck\": \"pending\",\n    \"flagsFraudAlert\": true,\n    \"auditUpdatedBy\": \"system\",\n    \"auditLastAction\": \"Account flagged for enhanced due diligence\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legalName": "<string>",
  "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "doingBusinessAs": "<string>",
  "legalDocument": "123456789012345",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "address": {
    "line1": "<string>",
    "zipCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "line2": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

PATCH

organizations

{id}

Atualizar uma Organização

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "legalName": "Lerian Studio",
  "doingBusinessAs": "Lerian Studio",
  "status": {
    "code": "INACTIVE",
    "description": "Acesso à Organização temporariamente suspenso aguardando revisão de conformidade."
  },
  "address": {
    "line1": "Avenida Paulista, 1234 - Centro",
    "line2": "CJ 123",
    "zipCode": "04696040",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "metadata": {
    "onboardingStatus": "under_review",
    "vertical": "payments",
    "riskTier": "high",
    "suspendedBy": "compliance-system",
    "flagsAmlCheck": "pending",
    "flagsFraudAlert": true,
    "auditUpdatedBy": "system",
    "auditLastAction": "Account flagged for enhanced due diligence"
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{id}"

payload = {
    "legalName": "Lerian Studio",
    "doingBusinessAs": "Lerian Studio",
    "status": {
        "code": "INACTIVE",
        "description": "Acesso à Organização temporariamente suspenso aguardando revisão de conformidade."
    },
    "address": {
        "line1": "Avenida Paulista, 1234 - Centro",
        "line2": "CJ 123",
        "zipCode": "04696040",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR"
    },
    "metadata": {
        "onboardingStatus": "under_review",
        "vertical": "payments",
        "riskTier": "high",
        "suspendedBy": "compliance-system",
        "flagsAmlCheck": "pending",
        "flagsFraudAlert": True,
        "auditUpdatedBy": "system",
        "auditLastAction": "Account flagged for enhanced due diligence"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    legalName: 'Lerian Studio',
    doingBusinessAs: 'Lerian Studio',
    status: {
      code: 'INACTIVE',
      description: 'Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.'
    },
    address: {
      line1: 'Avenida Paulista, 1234 - Centro',
      line2: 'CJ 123',
      zipCode: '04696040',
      city: 'São Paulo',
      state: 'SP',
      country: 'BR'
    },
    metadata: {
      onboardingStatus: 'under_review',
      vertical: 'payments',
      riskTier: 'high',
      suspendedBy: 'compliance-system',
      flagsAmlCheck: 'pending',
      flagsFraudAlert: true,
      auditUpdatedBy: 'system',
      auditLastAction: 'Account flagged for enhanced due diligence'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'legalName' => 'Lerian Studio',
    'doingBusinessAs' => 'Lerian Studio',
    'status' => [
        'code' => 'INACTIVE',
        'description' => 'Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.'
    ],
    'address' => [
        'line1' => 'Avenida Paulista, 1234 - Centro',
        'line2' => 'CJ 123',
        'zipCode' => '04696040',
        'city' => 'São Paulo',
        'state' => 'SP',
        'country' => 'BR'
    ],
    'metadata' => [
        'onboardingStatus' => 'under_review',
        'vertical' => 'payments',
        'riskTier' => 'high',
        'suspendedBy' => 'compliance-system',
        'flagsAmlCheck' => 'pending',
        'flagsFraudAlert' => true,
        'auditUpdatedBy' => 'system',
        'auditLastAction' => 'Account flagged for enhanced due diligence'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{id}"

	payload := strings.NewReader("{\n  \"legalName\": \"Lerian Studio\",\n  \"doingBusinessAs\": \"Lerian Studio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.\"\n  },\n  \"address\": {\n    \"line1\": \"Avenida Paulista, 1234 - Centro\",\n    \"line2\": \"CJ 123\",\n    \"zipCode\": \"04696040\",\n    \"city\": \"São Paulo\",\n    \"state\": \"SP\",\n    \"country\": \"BR\"\n  },\n  \"metadata\": {\n    \"onboardingStatus\": \"under_review\",\n    \"vertical\": \"payments\",\n    \"riskTier\": \"high\",\n    \"suspendedBy\": \"compliance-system\",\n    \"flagsAmlCheck\": \"pending\",\n    \"flagsFraudAlert\": true,\n    \"auditUpdatedBy\": \"system\",\n    \"auditLastAction\": \"Account flagged for enhanced due diligence\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://ledger.sandbox.lerian.net/v1/organizations/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"legalName\": \"Lerian Studio\",\n  \"doingBusinessAs\": \"Lerian Studio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.\"\n  },\n  \"address\": {\n    \"line1\": \"Avenida Paulista, 1234 - Centro\",\n    \"line2\": \"CJ 123\",\n    \"zipCode\": \"04696040\",\n    \"city\": \"São Paulo\",\n    \"state\": \"SP\",\n    \"country\": \"BR\"\n  },\n  \"metadata\": {\n    \"onboardingStatus\": \"under_review\",\n    \"vertical\": \"payments\",\n    \"riskTier\": \"high\",\n    \"suspendedBy\": \"compliance-system\",\n    \"flagsAmlCheck\": \"pending\",\n    \"flagsFraudAlert\": true,\n    \"auditUpdatedBy\": \"system\",\n    \"auditLastAction\": \"Account flagged for enhanced due diligence\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"legalName\": \"Lerian Studio\",\n  \"doingBusinessAs\": \"Lerian Studio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Acesso à Organização temporariamente suspenso aguardando revisão de conformidade.\"\n  },\n  \"address\": {\n    \"line1\": \"Avenida Paulista, 1234 - Centro\",\n    \"line2\": \"CJ 123\",\n    \"zipCode\": \"04696040\",\n    \"city\": \"São Paulo\",\n    \"state\": \"SP\",\n    \"country\": \"BR\"\n  },\n  \"metadata\": {\n    \"onboardingStatus\": \"under_review\",\n    \"vertical\": \"payments\",\n    \"riskTier\": \"high\",\n    \"suspendedBy\": \"compliance-system\",\n    \"flagsAmlCheck\": \"pending\",\n    \"flagsFraudAlert\": true,\n    \"auditUpdatedBy\": \"system\",\n    \"auditLastAction\": \"Account flagged for enhanced due diligence\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legalName": "<string>",
  "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "doingBusinessAs": "<string>",
  "legalDocument": "123456789012345",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "address": {
    "line1": "<string>",
    "zipCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "line2": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Cabeçalhos

Content-Type

string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id

string<uuid>

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

Authorization

string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

string<uuid>

obrigatório

O identificador único da Organização.

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

status

object

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

Show child attributes

address

object

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

Show child attributes

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'.

Restrições: as chaves devem ter no máximo 100 caracteres; valores de string no máximo 2000 caracteres. Objetos aninhados não são permitidos (os valores devem ser string, número ou booleano), a estrutura não pode exceder uma profundidade máxima de 10, e é permitido um máximo de 100 chaves.

Show child attributes

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

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

CPF, CNPJ ou outro documento de identificação legal da organização.

Maximum string length: 256

Exemplo:

"123456789012345"

status

object

Um objeto contendo informações sobre o status.

Show child attributes

address

object

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

Show child attributes

metadata

object

Show child attributes

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

Consultar uma Organização

Excluir uma Organização

⌘I