Skip to main content
GET
Retrieve an event

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

id
string<uuid>
required

Response

Event resource response

@context
string
default:/contexts/Event
@id
string<iri-reference>

Event IRI reference

Example:

"/events/91106968-1abd-4d64-85c1-4e73d96fb997"

@type
string
default:Event

JSON-LD resource type

id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

taxpayer
object
type
enum<string>
Available options:
credential.created,
credential.updated,
credential.deleted,
link.created,
link.updated,
link.deleted,
file.created,
extraction.created,
extraction.updated,
invoice.created,
invoice.updated,
invoice.deleted,
invoice_payment.created,
invoice_payment.updated,
invoice_line_item.created,
invoice_line_item.updated,
tax_return.created,
tax_return.updated,
tax_return.deleted,
export.created,
export.updated,
tax_status.created,
tax_status.updated,
tax_status.deleted,
tax_compliance_check.created,
tax_compliance_check.updated,
tax_compliance_check.deleted,
tax_retention.created,
tax_retention.updated,
tax_retention.deleted,
electronic_accounting_record.created,
electronic_accounting_record.updated,
electronic_accounting_record.deleted,
rpc_entidades.created,
rpc_entidades.updated,
rpc_acto.created,
rpc_acto.updated,
rpc_socios.created,
rpc_socios.updated,
shareholder_relation.created,
shareholder_relation.updated,
shareholder_relation_source.created,
rug_garantia.created,
rug_garantia.updated,
buro_de_credito_report.created,
buro_de_credito_report.updated,
sat_certificate.created,
sat_certificate.updated,
background_check.created,
company_verification_report.created,
company_verification_report.updated
Example:

"credential.updated"

source
string<iri-reference>

Source that originated the event

Example:

"/extractions/91106968-1abd-4d64-85c1-4e73d96fb997"

resource
string<iri-reference>

Resource related to the event

Example:

"/credentials/91106968-1abd-4d64-85c1-4e73d96fb997"

data
object

Resource data (data.object) and changes (data.changes)

Example:
createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"