Skip to content

Issuer Document Types ​

Manage which SRI document types an issuer is allowed to process. Document type eligibility is checked at invoice creation time — attempting to create a document of a disallowed type returns 400.

Authentication ​

Authorization: Bearer <api-key>

All endpoints below take the issuer id as a URL parameter and verify it belongs to your tenant before applying any change.


List document types ​

GET /v1/issuers/:id/document-types

Returns the active document types for the named issuer.

Path parameters ​

ParameterDescription
idIssuer UUID (from GET /v1/issuers)

Example ​

http
GET /v1/issuers/00000000-0000-0000-0000-000000000001/document-types
Authorization: Bearer <your-api-key>

Response ​

json
{
  "ok": true,
  "documentTypes": ["01"]
}

Add a document type ​

POST /v1/issuers/:id/document-types

Enables a new document type for the issuer. If the type was previously removed, it is reactivated.

Path parameters ​

ParameterDescription
idIssuer UUID

Request body ​

json
{
  "documentType": "01"
}
FieldTypeRequiredDescription
documentTypestringYesSRI document type code (see supported types below)

Response ​

Returns the full updated list of active document types.

json
{
  "ok": true,
  "documentTypes": ["01"]
}

Errors ​

StatusCodeWhen
400VALIDATION_FAILEDdocumentType is missing or not a supported type
402DOCUMENT_TYPE_NOT_IN_TIERThe type is implemented but not included in your subscription tier — see tier limits below
403FORBIDDENIssuer belongs to a different tenant
404NOT_FOUNDIssuer id does not exist

Remove a document type ​

DELETE /v1/issuers/:id/document-types/:code

Disables a document type for the issuer. The last active type cannot be removed.

Path parameters ​

ParameterDescription
idIssuer UUID
codeDocument type code to remove (e.g. 01)

Response ​

Returns the full updated list of active document types.

json
{
  "ok": true,
  "documentTypes": ["01"]
}

Errors ​

StatusCodeWhen
400VALIDATION_FAILEDcode is not a supported type
400LAST_DOCUMENT_TYPE_CANNOT_BE_REMOVEDAttempting to remove the issuer's last active document type
403FORBIDDENIssuer belongs to a different tenant
404NOT_FOUNDIssuer id does not exist, or the document type is not currently active for this issuer

Supported document types ​

CodeDescription
01Factura (Invoice)
04Nota de Crédito (Credit Note) — see Create Credit Note for the request body, which differs from an invoice's

Document type tier limits ​

TierAllowed types
FreeFactura (01)
StarterFactura (01)
GrowthFactura, Nota de Crédito (01, 04)
BusinessFactura, Nota de Crédito (01, 04)

This only gates enabling a new type — it never revokes one already active. If you downgrade plans, document types already enabled on your issuers keep working; you just can't enable further gated types until you upgrade again.

Comprobify API Documentation — API v1.3.1