Costa Rica e-Invoice Validator API - Hacienda

API ID 13427

Keyless Costa Rica Hacienda v4.4 comprobante validator: official XSD for 8 document types, the 50-digit clave numerica, CABYS code lists, totals/IVA math, XAdES-EPES signature check. Rule-coded JSON r

279 ms avg response

API Documentation

Endpoints

Request
Simple liveness probe for monitoring and uptime checks. Returns {"status":"ok"} with HTTP 200 when the validation service is up and ready to accept documents. No parameters, no body required.
Endpoint ID: 29087
GET https://www.zylalabs.com/api/13427/costa+rica+e-invoice+validator+api+-+hacienda/29087/health+check
INPUT PARAMETERS

Free test requests remaining: 3 of 3.

This endpoint does not require any input parameters.

API EXAMPLE RESPONSE
JSON
{
    "status": "ok"
}
Health check — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/13427/costa+rica+e-invoice+validator+api+-+hacienda/29087/health+check' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request
POST the raw Comprobante Electronico v4.4 XML as the request body (Content-Type: application/xml). The document type is auto-detected (FacturaElectronica, TiqueteElectronico, NotaCredito/Debito, MensajeReceptor, ReciboElectronicoPago, Compra, Exportacion). Returns a JSON validation report: valid, wellFormed, documentType, version, signatureValid, errorCount, warningCount and detailed rule-coded findings (CR-STRUCT-*, CR-CODE-*, CR-CLAVE-*, CR-SYSID-*, CR-MATH-*, CR-SIG-*) covering the Hacienda v4.4 XSDs, the 50-digit clave numerica decomposition and cross-checks, the mandatory ProveedorSistemas node, CABYS and other code lists, totals/IVA math and the enveloped XAdES-EPES signature. A non-compliant comprobante is still HTTP 200 - the verdict is "valid": false inside the JSON.
Endpoint ID: 29088
POST https://www.zylalabs.com/api/13427/costa+rica+e-invoice+validator+api+-+hacienda/29088/validate+e-invoice
INPUT PARAMETERS

Validate e-invoice — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{
    "valid": true,
    "wellFormed": true,
    "inputFormat": "xml",
    "documentType": "FacturaElectronica",
    "version": "4.4",
    "signatureValid": true,
    "errorCount": 0,
    "warningCount": 0,
    "findings": [
        {
            "level": "info",
            "ruleId": "CR-STRUCT-VERSION",
            "text": "Namespace declares Hacienda comprobante schema v4.4 (https://cdn.comprobanteselectronicos.go.cr/xml-schemas/v4.4/facturaElectronica).",
            "location": null,
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-STRUCT-XSD",
            "text": "Document is valid against the Hacienda v4.4 FacturaElectronica structural XSD.",
            "location": null,
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-SYSID-OK",
            "text": "System Identification node <ProveedorSistemas> present (v4.4 requirement).",
            "location": "ProveedorSistemas",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-CLAVE-CONSECUTIVO",
            "text": "Clave consecutivo segment matches <NumeroConsecutivo>.",
            "location": "Clave",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-CLAVE-TIPO",
            "text": "Tipo de comprobante '01' matches the root <FacturaElectronica>.",
            "location": "NumeroConsecutivo",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-MATH-COMPROBANTE",
            "text": "ResumenFactura totals reconcile to TotalComprobante.",
            "location": "ResumenFactura/TotalComprobante",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-SIG-CERT",
            "text": "Embedded signing certificate: subject 'C=CR,O=Persona Juridica,CN=EMPRESA EJEMPLO SA', issuer 'C=CR,O=Persona Juridica,CN=EMPRESA EJEMPLO SA'.",
            "location": "ds:X509Certificate",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-SIG-CERTDIGEST",
            "text": "XAdES SigningCertificate/CertDigest matches SHA-256 of the embedded certificate.",
            "location": "xades:SigningCertificate",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-SIG-EPES-POLICY",
            "text": "XAdES-EPES SignaturePolicyIdentifier present (explicit signature policy referenced).",
            "location": "xades:SignaturePolicyIdentifier",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-SIG-DOC-DIGEST",
            "text": "Document digest VERIFIES: recomputed SHA-256 over the enveloped document (ds:Signature removed, inclusive Canonical XML) matches the signed DigestValue.",
            "location": "ds:Reference[@URI='']",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-SIG-PROPS-DIGEST",
            "text": "SignedProperties digest VERIFIES: recomputed SHA-256 over the canonicalized xades:SignedProperties matches the signed DigestValue.",
            "location": "ds:Reference[@URI='#signed-props']",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-SIG-VALUE",
            "text": "SignatureValue VERIFIES: RSA-SHA256 over the canonicalized SignedInfo checks out against the embedded certificate's public key.",
            "location": "ds:SignatureValue",
            "occurrences": 1
        },
        {
            "level": "info",
            "ruleId": "CR-SIG-TRUST",
            "text": "Trust chain to a Costa-Rica CA (the 'Sistema Nacional de Certificacion Digital' / MICITT root and its policy CAs) is NOT verified here; that requires the SINPE/MICITT CA list and, for full assurance, an online Hacienda check. Structure and the embedded-certificate crypto are checked offline.",
            "location": null,
            "occurrences": 1
        }
    ]
}
Validate e-invoice — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/13427/costa+rica+e-invoice+validator+api+-+hacienda/29088/validate+e-invoice' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '
50615092500310112345600100001010000000001112345678
3101123456
620100
00100001010000000001
2025-09-15T10:00:00-06:00

Empresa Ejemplo Sociedad Anonima

02
3101123456


1
01
01
Direccion de ejemplo, edificio central

[email protected]


Cliente Ejemplo

01
0102030405


01


1
8511000000000
1.000
Unid
Servicio de ejemplo para prueba
10000.00000
10000.00000
10000.00000
10000.00000

01
08
13.00
1300.00000

0.00000
1300.00000
11300.00000




CRC
1.00000

10000.00000
10000.00000
10000.00000
0.00000
10000.00000
1300.00000
11300.00000

bAhSYwtm5VWtis0RL+Nc7RZ/ZgDpx2VBSPKtVGeGRnQ=34a+NpJTPGRMmCV+ln29wdgoinHY08vm6/tCeTrZ4H8=rGxnpJEbB6M7EP9AJRZDj2IJVIA6cG6kWszdeLVBqpoztFWi/qWdgBEybntcKoxaJ3ayyIG9jx7niHTjOXnp/ndPvbbInXVycNQM2r3i/TIb5QpLvHBgqtY3OKI3HuTknBKQNJJgwczExMGYFG/wUCzn2bvPULkUwsURHC5/ovNIVjc91HZq3Vg64HGHnjcbo2zaIbozOweYn7hQ8NrssPGgCytJ3dZfCCLDMMK/cUqzHkv9NBrBd0O13C8NPGEVhaS2kavbsb2YFS4na2Hp9+rrqib/GtyMWMf96FkPiY47vBInqTmCnMMEdeHqxgbKBhoa+rZ3ms7bdSVBiFSgyw==MIIDHDCCAgSgAwIBAgIGAZ+oZv99MA0GCSqGSIb3DQEBCwUAMEUxGzAZBgNVBAMMEkVNUFJFU0EgRUpFTVBMTyBTQTEZMBcGA1UECgwQUGVyc29uYSBKdXJpZGljYTELMAkGA1UEBhMCQ1IwHhcNMjYwNzI4MTAwNTUwWhcNMjcwNzI4MTEwNTUwWjBFMRswGQYDVQQDDBJFTVBSRVNBIEVKRU1QTE8gU0ExGTAXBgNVBAoMEFBlcnNvbmEgSnVyaWRpY2ExCzAJBgNVBAYTAkNSMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4k7ACXaxt1+Sf6Q+JDI8bs9uxPY6m0JKuDdLbrkeDSUP8QVfBIq/dVOTJ8soq55A0Stz0feS86lS0HvP3MQESbYomwbHIaeD00p9m4KoPX5f4otzaI5nuCE90kj0SkNCiKJUmbiUlPdAUawhD/PfmffpcFh7GT9KNXlCXmwSCzg7GlCRCrPF/ysE9n7bpQvCzDeNY96GCvsEvMj3huopln+qlXILo+mA/WplGocVWUANfot9K7DWFeN+cRujfIW71HjL5eByvI0zySd1cF3DVtcxb3VHvLLqNZuaOEkPUsoL3umoTqad6AkXCjDiCzrO04QRX+MPQfho6Rce0etHjwIDAQABoxIwEDAOBgNVHQ8BAf8EBAMCBsAwDQYJKoZIhvcNAQELBQADggEBALLN1ekF/A6vVYktftYGbTCB3+GE/7ES0939UqBp+ZxRIn3kvi1diPzn0+MFNwjsexTj7xOg7M6TzJnK8ew91rSDGD6evfllcn8oAo8kxcEisAK/Zx/pAB5Ni9kcnnSVVWOnEGUMtrmv5eVvUFFGS7tDDpCcIEiQLRoQEIIeFw35d1R5pLC+zT872NnoO3jPk7DDGP8vYII5BZCW6JUkJymvrRLM/jLc/1owHXICSAVY7UUX/5ptKYf1A2R4yq79x/M5Yq9LETwy3mWAZ4hrMx2/2R0V3dU4vo3CAG/VWIxORJlFgv7jaVULtkb/CRZigBkUurgy75iUN+bmDZUNSi0=2025-09-15T10:00:05-06:00/qdHl5jxomu5xM4OC2BQt69+SgFUXVv4Ib8uEr8Qvo4=C=CR,O=Persona Juridica,CN=EMPRESA EJEMPLO SA1785236750205https://tribunet.hacienda.go.cr/docs/esquemas/2016/v4.4/Resolucion_General_MH-DGT-RES-0027-2024.pdfKN6/2eZEAduZ3t0sn4aWMv8nmpGdaIcSso99Bp9QT04='

    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Costa Rica e-Invoice Validator API - Hacienda simply include your bearer token in the Authorization header.

Headers
Header Description
Authorization Required Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

(Save 2 months with annual billing 🎉)

🚀 Enterprise Plan

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring

Overview

Keyless Costa Rica Hacienda v4.4 comprobante validator: official XSD for 8 document types, the 50-digit clave numerica, CABYS code lists, totals/IVA math, XAdES-EPES signature check. Rule-coded JSON r

Costa Rica e-Invoice Validator API - Hacienda FAQs

The GET Health check endpoint returns a simple JSON object indicating the service status, while the POST Validate e-invoice endpoint returns a detailed JSON validation report that includes fields such as validity, document type, version, signature validity, error count, and findings related to compliance with Hacienda v4.4 standards.

Key fields in the POST Validate e-invoice response include "valid," "wellFormed," "documentType," "version," "signatureValid," "errorCount," "warningCount," and "findings," which provide insights into the validation status and specific compliance issues.

The response data is structured in a JSON format. The main validation status is presented at the top level, followed by detailed findings categorized by level (info, warning, error) that describe specific compliance checks and their results.

The GET Health check provides service status, while the POST Validate e-invoice offers comprehensive validation details for electronic invoices, including document type, version, signature checks, and compliance findings based on the official XSDs.

The POST Validate e-invoice endpoint accepts the raw XML of the Comprobante Electronico as the request body. No additional parameters are required, as the document type is auto-detected from the XML content.

Data accuracy is maintained through adherence to official XSD schemas and validation rules established by the Costa Rican Hacienda. The API checks for compliance with these standards, ensuring that the validation results reflect the current regulatory requirements.

Typical use cases include validating electronic invoices for compliance with Costa Rican tax regulations, ensuring proper document formatting, and verifying the integrity of digital signatures in e-invoices before submission to the Hacienda.

Users can utilize the returned data by interpreting the validation report to identify compliance issues, addressing any errors or warnings, and ensuring that their electronic invoices meet the necessary standards for acceptance by the Costa Rican Hacienda.

General FAQs

To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.

You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.

The free trial lasts for 7 days and allows you to make up to 50 API requests.

No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.

Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

You can monitor your API usage through the response headers included with every request:

x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.

The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.

Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund