Access requests

Buscar solicitação de acesso do usuário por ID

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

accessRequestIdstringObrigatório

ID da solicitação de acesso

Respostas

200

application/json

idstringOpcional

namestringOpcional

emailstringOpcional

email_confirmedbooleanOpcional

access_request_statusstring · enumOpcionalValores possíveis:

groupsstring[]Opcional

partner_idstringOpcional

partner_namestringOpcional

404

Access Request was not found

application/json

500

An internal server error was thrown

application/json

get/access-requests/{accessRequestId}

GET /api/b2b/access-requests/{accessRequestId} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "email": "text",
  "email_confirmed": true,
  "access_request_status": "APPROVED",
  "groups": [
    "text"
  ],
  "partner_id": "text",
  "partner_name": "text",
  "partner_form": {
    "name": "text",
    "type": "text",
    "state_registration_number": "text",
    "fiscal_registration_number": "text",
    "email": "text",
    "phone": "text",
    "mobile": "text",
    "address": {
      "postal_code": "text",
      "street": "text",
      "number": "text",
      "neighborhood": "text",
      "complement": "text",
      "state": "text",
      "city": "text"
    }
  },
  "additional_data_form": [
    {
      "form_field_id": "text",
      "form_field_title": "text",
      "form_id": "text",
      "value": {}
    }
  ]
}

Atualizar solicitação de acesso

put

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

accessRequestIdstringObrigatório

ID da solicitação de acesso

Corpo

groupsstring[]Opcional

partner_idstringOpcional

Respostas

200

application/json

idstringOpcional

namestringOpcional

emailstringOpcional

email_confirmedbooleanOpcional

access_request_statusstring · enumOpcionalValores possíveis:

groupsstring[]Opcional

partner_idstringOpcional

partner_namestringOpcional

404

Access Request was not found

application/json

500

An internal server error was thrown

application/json

put/access-requests/{accessRequestId}

PUT /api/b2b/access-requests/{accessRequestId} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 415

{
  "groups": [
    "text"
  ],
  "partner_id": "text",
  "partner_form": {
    "name": "text",
    "type": "text",
    "state_registration_number": "text",
    "fiscal_registration_number": "text",
    "email": "text",
    "phone": "text",
    "mobile": "text",
    "address": {
      "postal_code": "text",
      "street": "text",
      "number": "text",
      "neighborhood": "text",
      "complement": "text",
      "state": "text",
      "city": "text"
    }
  },
  "additional_data_form": [
    {
      "form_field_id": "text",
      "form_id": "text",
      "value": {}
    }
  ]
}

{
  "id": "text",
  "name": "text",
  "email": "text",
  "email_confirmed": true,
  "access_request_status": "APPROVED",
  "groups": [
    "text"
  ],
  "partner_id": "text",
  "partner_name": "text",
  "partner_form": {
    "name": "text",
    "type": "text",
    "state_registration_number": "text",
    "fiscal_registration_number": "text",
    "email": "text",
    "phone": "text",
    "mobile": "text",
    "address": {
      "postal_code": "text",
      "street": "text",
      "number": "text",
      "neighborhood": "text",
      "complement": "text",
      "state": "text",
      "city": "text"
    }
  },
  "additional_data_form": [
    {
      "form_field_id": "text",
      "form_field_title": "text",
      "form_id": "text",
      "value": {}
    }
  ]
}

Excluir usuário da solicitação de acesso

delete

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

accessRequestIdstringObrigatório

ID da solicitação de acesso

Respostas

204

Access Request deleted successfully

Sem conteúdo

404

Access Request was not found

500

An internal server error was thrown

delete/access-requests/{accessRequestId}

DELETE /api/b2b/access-requests/{accessRequestId} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sem conteúdo

Listar solicitações de acesso do portal

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcional

dirstringOpcionalDefault: asc

Respostas

200

Access Request listed

application/json

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

Portal was not found

application/json

422

A query param was invalid

application/json

500

An internal server error was thrown

application/json

get/access-requests

GET /api/b2b/access-requests HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "email": "text",
      "partner_id": "text",
      "partner_fiscal_registration_number": "text",
      "fiscal_registration_number": "text",
      "access_request_status": "APPROVED",
      "access_request_date": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}