Quickstart

This walkthrough takes you from credentials in hand to a completed credential verification. Every request in this guide targets the Demo environment (https://api.demo.propelus.com) so you can experiment safely. See Environments for the full base-URL list.

Prerequisites

You need an API key and a client ID. Every request must send both as headers. See Authentication for how they work and how to get them.

1. Make your first request

The simplest call is the read-only Profession Status endpoint, which lists the professions Propelus can verify and the profession codes you'll use later.

curl https://api.demo.propelus.com/v2/professions \
  -H "x-api-key: $PROPELUS_API_KEY" \
  -H "x-client-id: $PROPELUS_CLIENT_ID"

A successful call returns 200 with a list of professions:

{
  "code": "ok",
  "message": "Professions retrieved successfully.",
  "size": 1,
  "items": [
    {
      "professionCode": "RN",
      "professionName": "Registered Nurse Illinois",
      "professionState": "CA",
      "boardName": "Alabama Board of Nursing",
      "boardUrl": "https://abn.alabama.gov/applications/License.aspx",
      "licenseFormatRegex": "[0-9]{8,9}|041.[0-9]{4,9}",
      "licenseFormatRegexMask": "0412345678 / 041.12345678",
      "professionStatus": "AUTOMATED"
    }
  ]
}

The response body above is derived from the API schema. Field values you see against a live Demo key may differ.

If you get a 401 or 403 instead, your headers are missing or incorrect. See Authentication.

2. Run a credential verification

Verifications run asynchronously. You submit a batch, get a batchId back immediately, and then poll for results (or, better, receive a webhook when it finishes).

Submit one or more credentials to Verify Credentials Batch. The professionCode must be a value returned by /v2/professions in step 1. An unrecognized code returns a 400 with code: unsupported_profession.

curl -X POST https://api.demo.propelus.com/v2/credentials \
  -H "x-api-key: $PROPELUS_API_KEY" \
  -H "x-client-id: $PROPELUS_CLIENT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "credentials": [
      {
        "professionCode": "RN",
        "professionState": "CA",
        "licenseNumber": "0412345678",
        "firstName": "Jane",
        "lastName": "Doe"
      }
    ]
  }'

The API responds 202 Accepted. The batch is queued but not yet complete:

{
  "code": "processing",
  "detail": "Batch accepted and is being processed.",
  "batchId": "a1b2c3d4-0000-0000-0000-000000000000",
  "resultsUrl": "/v2/credentials/a1b2c3d4-0000-0000-0000-000000000000"
}

3. Retrieve the results

Poll Get Credentials Batch with the batchId (the resultsUrl above is the same path). Keep polling until code is completed or failed:

curl https://api.demo.propelus.com/v2/credentials/a1b2c3d4-0000-0000-0000-000000000000 \
  -H "x-api-key: $PROPELUS_API_KEY" \
  -H "x-client-id: $PROPELUS_CLIENT_ID"

Use a backoff between polls rather than a tight loop. See Rate limits for the recommended pattern.

Next steps

• Register a webhook to have Propelus push results to you when a batch finishes, so you can stop polling.
• Use the Monitoring endpoints to get ongoing alerts when a credential changes, instead of re-running one-time checks.
• Read the Errors reference so your integration recovers cleanly from failures.
• When you are ready to go live, switch to Production by following the Environments guide.