← HomeFleetPay / API

Upload an A1 digital certificate

Parameters, data structure and responses from the versioned contract.

POST/fiscal/certificado

uploadFiscalCertificateSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Uploads or replaces the carrier's digital certificate.

Authentication

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

No parameters declared for this operation.

Request Body

Required

`multipart/form-data`

filestring · binaryRequired

A1 certificate in .pfx or .p12 format, up to 10 MB.

cert_passstring · passwordRequired

Certificate password; never returned by the API.

Responses

201 HTTP Response

Digital certificate uploaded and metadata updated.

`application/json`

CertificateEnvelope ↗

dataobjectRequired

CertificateMetadata ↗

environmentobjectRequired

Environment ↗

Headers

X-Request-Id

Call correlation identifier.

401 HTTP Response

FleetPay API key missing or invalid.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

403 HTTP Response

Fiscal scope disabled for the key, or no active carrier associated with the key.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

422 HTTP Response

Invalid payload.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

429 HTTP Response

Per-carrier limit exceeded.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

Retry-After

Seconds until another attempt.

500 HTTP Response

Internal failure without operational integration details.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

Complete Operation Definition

{
  "tags": [
    "Configuração"
  ],
  "summary": "Enviar certificado digital A1",
  "description": "Envia ou substitui o certificado digital da transportadora.",
  "operationId": "uploadFiscalCertificate",
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "required": [
            "file",
            "cert_pass"
          ],
          "properties": {
            "file": {
              "type": "string",
              "format": "binary",
              "description": "Certificado A1 em .pfx ou .p12, com no máximo 10 MB."
            },
            "cert_pass": {
              "type": "string",
              "format": "password",
              "description": "Senha do certificado; nunca é devolvida pela API."
            }
          }
        },
        "encoding": {
          "file": {
            "contentType": "application/x-pkcs12, application/octet-stream"
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "$ref": "#/components/responses/CertificateCreated"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "422": {
      "$ref": "#/components/responses/ValidationFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "POST",
  "path": "/fiscal/certificado",
  "parameters": []
}