Developers · Live
The live
integration model.
Start with CSV and the dashboard. This page shows the API, event and record model Arrota intends to support; it is not live reference documentation.
Integration overview
Issue records and receive lifecycle updates.
Into Arrota
Your system issues
Issue certificate-style credentials programmatically from your system of record when spreadsheets no longer fit the workflow. Employment and background-check records follow the app’s verification workflow and are not issued over the API.
Out of Arrota
Arrota reports back
Claims, corrections, revocations and supersessions arrive as signed events, so your records stay in step.
Authentication and API keys · Live
Scoped keys, revocable in a click.
The model uses organisation-scoped API keys with only the permissions each integration needs. Rotation and revocation are part of that model.
Key management, full reference documentation and sandbox credentials will be published when the integration surface is ready.
-
Active
sis-integration
live_key_···········7f2a
-
Read only
status-readonly
live_key_···········91cd
Keys are shown once, scoped per integration, revocable independently.
Webhooks · Live
Lifecycle events delivered by webhook.
Every post-issuance change your systems care about, delivered as a signed event your endpoint can verify.
Issuance completed — one event per credential, whether single, bulk or API.
The recipient claimed the credential into their vault.
The issuing organisation withdrew the credential.
A holder asked your organisation to confirm a record.
Your organisation resolved a verification request.
Events are signed so your endpoint can verify origin before trusting them.
The record model · Live
A generic record model with employment schemas.
The platform uses a generic record model. Employment is one schema applied to an Organisation-confirmed record; degree, licence, and certification records will use the same verification engine.
The live webhook vocabulary is credential.issued, credential.claimed, credential.revoked, verification.requested and verification.decided — the same five events documented above, versioned together with the API.
IssuerBackedRecord ├── issuer ├── holder ├── record_type: employment ├── record_status ├── source_status ├── schema_version ├── employment_fields │ status · employer · start · end │ current_role · final_role · type ├── disclosure_policy └── verification_eligibility
Also planned: VerificationRequest, ClaimMatch, Authorisation, VerificationResult, VerificationCreditLedger, IssuerReviewRequest.
Retrieval, formats, sandbox · Planned
Retrieve records in portable formats.
Status and retrieval
Fetch a credential or its current lifecycle state by ID using the same status vocabulary as the public pages.
Open Badges 3.0
Where supported, records export as Open Badges 3.0 for use outside Arrota.
Sandbox and limits
A testing environment and documented rate limits will be published with issuer access.
Start manual. Integrate when ready.
Both paths use the same records, so switching does not require a migration.