Reading License Results – Propelus Data Solutions

After submitting a batch to Propelus, results arrive asynchronously and can be fetched using the batchId. The batch status indicates progress (QUEUED_FOR_MV, PROCESSING, COMPLETED, FAILED), with individual license results available only when COMPLETED. Each license result includes fields such as isFound, code, status, detail, and verified license data. Result codes clarify outcomes, and a screenshotURL provides an audit trail available for 7 days after verification.

For your technical team: Use the verificationUrl from the submit response, or build the URL yourself with the batchId path parameter.

GET https://api.propelus.com/v1/licenses/results/{batchId}

or .../v1/licensesandcertifications/results/{batchId}.

Batch status

The top level tells you where the whole batch stands. Individual results are only available once status is COMPLETED — poll until then, using lastVerification to watch progress.

Field	What it tells you
status	Batch status: `QUEUED_FOR_MV`, `PROCESSING`, `COMPLETED`, or `FAILED`.
recordsReceived	Number of licenses in the batch.
createdAt	UTC time the batch was submitted.
lastVerification	Last time the batch updated — poll against this to track progress.
clientMetadata	The batch object you sent, echoed back unchanged.
licenses[]	One result per license. Detailed below.

Each license result

Every entry in licenses[] reports one license. Review isFound first, then code and detail for the "why"; the verified data sits in result.

Field	What it tells you
isFound	`true` when the license was located — its data is in `result`.
code	Machine-readable outcome (see codes below).
status	This license’s status: `COMPLETED`, `FAILED`, or `MV_QUEUED`.
detail	Human-readable message explaining the outcome.
input	The license request you sent, echoed back.
customProperties	Your per-license identifiers, echoed back.
result	The verified license data — present when `isFound` is `true`.
firstName / middleName / lastName	The licensee’s name as the board has it.
licenseNumber	The verified license number.
licenseStatus	The board’s status for the license (e.g. active, expired).
originalIssueDate	When the license was first issued.
expirationDate	When the license expires.
disciplinaryAction	Any disciplinary action on the license, or `null` if none.
screenshotURL	Link to a captured screenshot of the board’s record — your audit trail.
customFields	Any extra board-specific fields returned for this license.

Result codes

Each license’s code tells you exactly what happened. A FAILED status always comes with an err_ code.

Code	What it means
found	The license was located and verified.
not_found	No matching license was found at the board.
`err_missing_req_flds`	A required field was missing from the request.
`err_missing_val_flds`	A field the board requires (a conditional field) wasn’t provided.
`err_state_not_found`	The `stateCode` wasn’t recognized.
`err_profession_not_found`	The `professionCode` wasn’t recognized.
`err_unsuppported_profession`	That profession isn’t supported for this state/board.
`err_processing`	Something went wrong while verifying. Retry; if it persists, contact support.

{
  "status": "COMPLETED",
  "recordsReceived": 10,
  "createdAt": "2019-08-24T14:15:22Z",
  "lastVerification": "2019-08-24T14:18:03Z",
  "clientMetadata": {},
  "licenses": [
    {
      "code": "found",
      "status": "COMPLETED",
      "isFound": true,
      "detail": "License verified — active.",
      "input": { "licenseNumber": "RN1234567", "professionCode": "RN", "stateCode": "FL" },
      "result": {
        "firstName": "John",
        "lastName": "Snow",
        "licenseNumber": "RN1234567",
        "licenseStatus": "Active",
        "originalIssueDate": "2014-06-01",
        "expirationDate": "2026-04-30",
        "disciplinaryAction": null,
        "screenshotURL": "https://…"
      }
    }
  ]
}

(!) Keep the screenshot: screenshotURL. it's a captured image of the board’s record at verification time — a strong audit trail for compliance files. The image is available for 7 days after posting.

Where to go next

Need the full meaning of every status and code? See verification result codes.

Setting up a license batch? Back to verify licenses & certifications.