Record a provenance event
Record one moment in the provenance of a possession.
Only the type is required. The change is written to the account log.
Parameters
Sent as JSON. Anything not listed here is ignored.
The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.
The id of the possession. A possession of another vault or of another account answers 404.
What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other.
How much of the date is known: day, month, year, circa or unknown.
When it happened, in the shape its precision gives: 1980-01-20, 1980-01 or 1980. A date in another shape is refused with “Write the date in the shape its precision asks for.” Ignored when the precision is unknown.
What happened in a few words, up to 255 characters. Markup is stripped.
Who it came from, up to 255 characters.
Who held it afterwards, up to 255 characters.
Where it happened, up to 255 characters.
What happened and how it is known, up to 5,000 characters.
The reference of the record, up to 255 characters.
A full web address where the event can be checked, up to 255 characters.
The id of a transaction of the same possession that records what the moment cost. A transaction of another possession answers 422.
Whether a document, a record or an expert confirms the event.
Returns
The provenance event object that was recorded.
The possession provenance event.
Always possession_provenance_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
What happened: origin, acquisition, inheritance, gift, sale, custody, loss, recovery, authentication, exhibition, publication or other.
The group the type belongs to: ownership, custody or authenticity.
What happened in a few words, or null, in which case the application shows the name of the type.
How much of the date is known: day, month, year, circa or unknown.
When it happened, in the shape its precision gives: 1980-01-20 for a day, 1980-01 for a month, 1980 for a year or around a year, null when unknown.
Who it came from, as text, or null.
Who held it afterwards, as text, or null.
Where it happened, as text, or null.
What happened and how it is known, or null.
The reference of the record (a lot, a deed, a certificate), or null.
Where the event can be checked, or null.
Whether a document, a record or an expert confirms the event.
The id of the transaction of the same possession that records what the moment cost, or null. An event holds no money of its own.
When the event was recorded, as a count of seconds since 1970.
Where to find this record.
The absolute address this record is read from.
The Provenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.