e-Próspera
Reference

Get a Certificate of Good Standing request

View as Markdown
GET
/api/v1/legal_entities/{id}/certificate_requests/{requestId}

Poll until statusId is Issued, Rejected, or Cancelled, then stop. Only Issued provides the certificate PDF at documentUrl, also listed in the entity documents. For Rejected, show rejectionReason; cancellation or rejection is terminal and must not trigger automatic repayment. Standard keys act on every entity the key owner actively represents. Agent Keys are limited to entities incorporated through the API and need active representation and the listed agent:entity.filing.* scope. Agent writes also require an active Manifestation of Will. OAuth tokens and Partner Keys cannot call these filing endpoints. See https://docs.eprospera.com/entity-filings for signing, payment, and recovery. Agent scope: agent:entity.filing.read.

Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.

Authorization

AuthorizationBearer <token>

Personal standard API key. Send it as Authorization: Bearer sk-... and never delegate it.

In: header

Path Parameters

id*string
Formatuuid
requestId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/legal_entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/certificate_requests/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "legalEntityId": "41192155-f2be-4dd0-9ea4-e32ad94824f7",    "type": "certificate_of_good_standing",    "statusId": "Draft",    "contested": true,    "taxContestNote": "string",    "taxPaymentProofUrl": "http://example.com",    "contestedAt": "2019-08-24T14:15:22Z",    "rejectionReason": "string",    "reviewedAt": "2019-08-24T14:15:22Z",    "issuedAt": "2019-08-24T14:15:22Z",    "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",    "documentUrl": "http://example.com",    "invoice": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "statusId": "string"    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "nextSteps": {      "paymentRequired": true,      "awaitingReview": true,      "issued": true    }  }}

Request a Certificate of Good Standing POST

Creates a request and its invoice, or returns the entity's existing open or issued request. Reuse after review or issuance does not re-check current tax eligibility. Pay the invoice with a voucher, or in the portal, to have the certificate issued. Tax-current entities are issued automatically after payment; contested requests go to admin review. Returns 409 with code `certificate.tax_overdue` when overdue taxes block the request and no contest was supplied. Standard keys act on every entity the key owner actively represents. Agent Keys are limited to entities incorporated through the API and need active representation and the listed `agent:entity.filing.*` scope. Agent writes also require an active Manifestation of Will. OAuth tokens and Partner Keys cannot call these filing endpoints. See https://docs.eprospera.com/entity-filings for signing, payment, and recovery. Agent scope: `agent:entity.filing.create`. Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.

Pay a Certificate of Good Standing request with a voucher POST

Applies the voucher to the request invoice. Issuance runs asynchronously after payment. Poll until `statusId` is `Issued`, `Rejected`, or `Cancelled`, then stop. A certificate `documentUrl` is available only for `Issued`; rejected or cancelled requests must not trigger automatic repayment. Standard keys act on every entity the key owner actively represents. Agent Keys are limited to entities incorporated through the API and need active representation and the listed `agent:entity.filing.*` scope. Agent writes also require an active Manifestation of Will. OAuth tokens and Partner Keys cannot call these filing endpoints. See https://docs.eprospera.com/entity-filings for signing, payment, and recovery. Agent scope: `agent:entity.filing.pay`. Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.