e-Próspera
Reference

Create an amendment filing

View as Markdown
POST
/api/v1/legal_entities/{id}/amendments

Creates the entity's open amendment draft, or reuses the existing Draft, and replaces all proposals; omitted fields are cleared. The response includes nextSteps.signatureUrl: an active representative must sign the amendment in the portal before it can be paid. Returns 409 while another amendment is pending review or a signed filing is awaiting payment. 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.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

At least one non-null change is required. POST replaces the proposed changes; omitted fields are cleared.

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/amendments" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "legalEntityId": "41192155-f2be-4dd0-9ea4-e32ad94824f7",    "statusId": "Draft",    "proposedChanges": {      "name": "string",      "extension": "string",      "nameStartsWithExtension": true,      "principalOfficeAddress": {        "line1": "string",        "line2": "string",        "city": "string",        "state": "string",        "postalCode": "string",        "country": "string"      }    },    "signed": true,    "signedAt": "2019-08-24T14:15:22Z",    "invoice": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "statusId": "string"    },    "submittedAt": "2019-08-24T14:15:22Z",    "approvedAt": "2019-08-24T14:15:22Z",    "rejectedAt": "2019-08-24T14:15:22Z",    "rejectedReason": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "nextSteps": {      "changesRequired": true,      "signatureUrl": "http://example.com",      "paymentRequired": true,      "reviewDispatchPending": true,      "submitReady": true    }  },  "nextSteps": {    "changesRequired": true,    "signatureUrl": "http://example.com",    "paymentRequired": true,    "reviewDispatchPending": true,    "submitReady": true  }}

List amendment filings for a legal entity GET

Returns every amendment filing (name and principal office changes) for the entity, newest first. 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.

Get an amendment filing GET

Poll this endpoint after submission; terminal states are `Approved` and `Rejected`. Approved amendments add a Certificate of Amendment to the entity documents. 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.