Crystal Ready — Integration guide

HOSTED JOURNEYS AND WEB SDK
Your backend creates a verification and an applicant or SDK session using
the project's configured workflow. Keep the project API key on your server.
Give the applicant their hosted link or mount the Web SDK in your portal:

<script src="https://crystalready.com/sdk/v1/crystalready.js"></script>

const widget = CrystalReadySDK.mount(document.getElementById('verification'), {
  serviceOrigin: 'https://crystalready.com',
  url: session.url,
  onEvent(event) { updateJourneyUI(event.type); }
});

Call widget.destroy() when leaving the page. Browser events describe interface
progress. Read verification outcomes from your authenticated backend.

READING RECORDS
Authorization: Bearer YOUR_PROJECT_API_KEY
Required scope: verifications:read

GET /v1/templates/current
GET /v1/verifications?limit=25
GET /v1/verifications/{verification_id}
GET /v1/verifications/{verification_id}/report
GET /v1/verifications/{verification_id}/participants

GET /v1/verifications returns items and next_cursor. Pass the cursor back
unchanged to retrieve another page. Verification IDs are UUIDs.
Preserve result_validity, assessment freshness and report limitations.
Collection completion and a verified result are different states.

MCP
Download /assets/landing/crystalready-mcp.mjs.
Setup instructions: /assets/landing/mcp-guide.txt.
The MCP connector reads the same records using the same project permissions.

WORKSPACE CONFIGURATION
Use your workspace's developer area for project credentials and the configured
workflow/session contracts. The key's environment, permissions and project
configuration determine which operations are available. Contact the team to
agree the required verification scope before enabling a customer journey.