e-Próspera
Reference

Pay a Certificate of Good Standing request with a voucher

View as Markdown
POST
/api/v1/legal_entities/{id}/certificate_requests/{requestId}/pay/voucher

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.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/legal_entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/certificate_requests/497f6eca-6276-4993-bfeb-53cbbbba6f08/pay/voucher" \  -H "Content-Type: application/json" \  -d '{    "voucherCode": "string"  }'
{  "success": true,  "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    }  },  "message": "string"}