List entities
With a key, its own business alone: a key acts for one. With a person's session, the organization's practice and live businesses, each with its kind.
Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.
In: header
Query Parameters
How many per page, from 1 to 100.
1 <= value <= 10020The next_cursor or prev_cursor of a previous response. Without a cursor, the first page.
length <= 200Only the businesses of this kind: sandbox ones issue with a sandbox key, live ones with a test or live key. Without it, all of them.
Value in
- "sandbox"
- "live"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/ec/entities"{ "object": "list", "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "entity", "kind": "sandbox", "country": "ec", "ruc": "string", "legal_name": "string", "trade_name": "string", "head_office_address": "string", "head_office_phone": "string", "head_office_email": "string", "reply_to_email": "string", "footer_legend": "string", "keeps_accounting": true, "regime": "general", "special_taxpayer_resolution": "string", "withholding_agent_resolution": "string", "large_taxpayer_resolution": "string", "certificate": { "holder": "string", "holder_identification": "string", "holder_identification_type": "cedula", "kind": "natural_person", "issuer_name": "string", "subject": "string", "issuer": "string", "serial_number": "string", "valid_from": "2019-08-24T14:15:22Z", "valid_until": "2019-08-24T14:15:22Z" }, "portal_shows_test": true, "live_since": "2019-08-24T14:15:22Z", "issuing": { "allowed": true, "lock": { "code": "plan_required", "message": "string", "canceled": true } }, "logo": { "url": "http://example.com", "content_type": "image/png", "size": 0 }, "created_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "string", "prev_cursor": "string"}Create an entity POST
Only a person, from the platform: an API key acts for the business it was created for (`403 person_required`). A `sandbox` business practices with made-up data and is free; a `live` one is registered by its RUC, which is looked up in the SRI registry where its data is taken from, and issues in `test` and `live` once paid.
Get an entity GET
The business with its `kind` and its current certificate, if it has one. To find out what it still needs before issuing, use `GET /v1/ec/entities/{id}/readiness`.