Skip to main content

Semble Integration

Real ID can automatically sync ID verification status to patient records in Semble, a Patient CRM system used by healthcare providers.

This integration allows healthcare providers to see verification status directly on patient records as labels, making it easy to track which patients have completed identity verification.

How does it work?​

Real ID integrates with Semble using their GraphQL API. When a customer completes (or starts) an ID check, Real ID automatically:

  1. Searches for the patient in Semble using their email address
  2. Removes any existing ID check label from the patient
  3. Adds the appropriate label based on the current verification status

This happens in real-time as the verification status changes, keeping your patient records always up to date.

Patient Labels​

The following verification statuses are synced as patient labels in Semble:

LabelDescription
ID check in progressCustomer has started but not completed verification
ID check in reviewVerification is being manually reviewed
ID check approvedCustomer successfully verified their identity
ID check failedVerification was unsuccessful
ID check manually approvedMerchant manually approved the verification
ID check manually rejectedMerchant manually rejected the verification

Labels are created automatically in Semble when needed. You don't need to create them manually.

Setting Up the Integration​

Step 1: Get Your Semble API Key​

First, you'll need to generate an API key in your Semble account:

  1. Log into your Semble account
  2. Navigate to Settings > API Access
  3. Generate a new API key
  4. Copy the API key for the next step

Step 2: Connect Real ID to Semble​

Open the Real ID Settings > WooCommerce tab and scroll to the Semble Patient Label Syncing settings.

  1. Toggle Enable Semble Integration to on
  2. Enter your API Key from Semble
  3. Click Test Connection to verify the credentials work
  4. Click Save in the top right corner

Once connected, Real ID will automatically sync verification statuses to patient records.

Patient Matching​

Real ID matches patients in Semble using the email address from the ID check. For syncing to work:

  • The patient must already exist in Semble
  • The patient's email in Semble must match the email used for the ID check
  • Email matching is case-insensitive

If a patient isn't found in Semble, the sync is skipped and you'll see this noted in the ID check events.

Synced Patient Data​

In addition to labels, Real ID can also sync verified data from the ID document to the patient record:

  • Date of Birth: When verification completes successfully, the date of birth extracted from the ID document is synced to the patient record in Semble

This helps ensure patient records have accurate, verified information.

Viewing Sync Events​

Each Semble sync action is logged as an event on the ID check. To view these events:

  1. Open the ID check details in your WooCommerce admin
  2. Scroll to the Events section
  3. Look for events related to Semble syncing

Events will show whether the sync succeeded, was skipped (patient not found), or encountered an error.

Frequently Asked Questions​

Why isn't the patient label updating?​

Check the following:

  1. Integration enabled: Verify the Semble integration is enabled in settings
  2. API key valid: Use the "Test Connection" button to verify your credentials
  3. Patient exists: The patient must already exist in Semble with a matching email
  4. Email matches: The email on the ID check must match the patient's email in Semble

What happens if the patient doesn't exist in Semble yet?​

If Real ID can't find a patient with a matching email in Semble, the sync is skipped. The system includes automatic retry logic to handle cases where patients are being imported to Semble with a slight delay.

Can I sync historical ID checks?​

Yes, contact support to request a bulk sync of historical ID checks to Semble. This is useful when first setting up the integration.

How quickly do labels update?​

Labels are updated in real-time as verification status changes. You should see the label appear on the patient record within seconds of the status change.

Can I customize the label names?​

The label names are standardized to ensure consistency. All labels are prefixed with "ID check" followed by the status, making them easy to identify and filter in Semble.

What if a patient has multiple ID checks?​

Each time an ID check status changes, the previous ID check label is removed and replaced with the new one. A patient will only ever have one ID check label at a time, reflecting their most recent verification status.