v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Visualizar onboarding

Retorna as informações básicas de uma solicitação de cadastro.

get/clients/{onboarding_id}

Path parameters

onboarding_idstring required

Id do onboarding.

Response

200

Example response

{
  "data": {
    "id": "446753cb-4979-467a-b14b-add28241fb3f",
    "type": "client",
    "attributes": {
      "status": "awaiting_onboarding",
      "documentNumber": "85432116000135",
      "legalNature": "LTDA",
      "nire": "11111111111",
      "name": "Dunder Mifflin",
      "companyName": "Dunder Mifflin Paper Company",
      "email": "corporate@dunder-mifflin.paper",
      "commercialPhone": "11988776655",
      "requiredSigners": 1,
      "onboardingUrl": "https://cadastros.grafeno.be/onboardings/v2/pages/natureza-juridica?token=5c13b8d3-5336-4fc1-bd6f-f3e3b42ddf72",
      "articleOfAssociation": {
        "data": {
          "id": "b6f37334-9da6-4104-bcea-b18fc9f368a7",
          "type": "file",
          "attributes": {
            "filename": "association.pdf",
            "content": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgICAgMCAgID"
          }
        }
      },
      "address": {
        "data": {
          "type": "address",
          "attributes": {
            "zipCode": "01230000",
            "street": "Rua Doutor Albuquerque Lins",
            "number": "111",
            "complement": "APT 222",
            "country": "BR",
            "state": "SP",
            "city": "SÃO PAULO",
            "neighborhood": "SANTA CECÍLIA"
          }
        }
      }
    }
  }
}