Home
Developers

API-first platform

Anything a user can do in Verify, your systems can do too.

Every action the Verify interface performs is an authenticated REST call, made server-side. That means your loan origination system, CRM or core can create customers, run checks, execute scorecard rules and read results without anyone re-keying a thing.

Open the API reference Request sandbox access

Run a verify action on a customerPOST /verify-api/verifyentity
sitekey: ••••••••••••
Authorization: Bearer ••••••••

{
  "actionId": 14,
  "sessionId": "•••",
  "command": "VerifyEntityID",
  "customers": [ { "customerKey": 223 } ]
}

Why API-first

Built to be connected.

Flexibility

Many endpoints are available for general use, and others are configured to your process.

Integration

A bridge between Verify and your LOS, CRM, ERP or core, with no human in the middle.

Scalability

Bulk and persistent connections for high-volume feeds through the API and socket service.

Innovation

New endpoints ship as new workflows do, and custom endpoints are available on request.

Endpoints

The Verify API at a glance.

JSON over HTTPS. Each call carries your site key and a bearer token, and each request names its action. See the interactive reference for request and response details.

Sessions & security

POST/verify-api/logonStart a session for a user.

POST/verify-api/logoffEnd the session so data stays secure after the task.

POST/verify-api/resetpasswordSet a new password for a user.

POST/verify-api/encryptdataEncrypt a value so only authorized users can read it.

POST/verify-api/decryptdataReturn encrypted data to its original form, for authorized callers.

Customers & verification

POST/verify-api/upsertcustomerAdd a new customer or update an existing one, including business, individual, address, NAICS and SIC data.

GET/verify-api/getcustomerFetch one or more customers by key or name.

GET/verify-api/getcustomersRetrieve all customers, like a directory.

GET/verify-api/getstatusGet the verification status of one or more customers.

POST/verify-api/verifyentityRun a Verify action, such as identity verification, on one or more customers.

Rules & summaries

POST/verify-api/executeruleRun a decision rule or scorecard with your inputs and threshold, and get the result.

GET/verify-api/getrulelistList the rules and scorecards configured for your instance.

GET/verify-api/getpolicysummariesRetrieve entity and policy summaries without the full detail.

Utilities

POST/verify-api/sendemailSend a templated email, from a group alert to a task reminder.

GET/verify-api/zipcodelookupReturn the details associated with a ZIP code.

Plus custom and extended endpoints built for specific business needs.

Scorecards by API

Your LOS asks. The rule engine answers.

Execute Rule takes a scorecard's inputs and threshold and returns the result, using the same rules reviewers see in the interface. Your origination system can pre-qualify an application before anyone opens it, and the call is still recorded.

Scorecards in customer due diligence

Execute a scorecard rulePOST /verify-api/executerule

{
  "actionId": 31,
  "decisionRule": {
    "dataInput": {
      "scoreThreshold": 75,
      "scorecardInputs": [
        { "name": "Years in Business", "value": 2 },
        { "name": "Sanctions Clear",  "value": true }
      ]
    }
  }
}

Common questions

Straight answers.

How do I authenticate to the Verify API?

Each call carries your instance's site key in a header and a bearer token. A session starts with the Logon endpoint and ends with Log-off. Credentials and site keys are issued per environment.

Is there an OpenAPI specification?

Yes. The Verify API is described in OpenAPI 3.0, and you can browse it in our interactive API reference. Full examples and a sandbox are available to customers and evaluators.

Can you add an endpoint we need?

Yes. Many endpoints started as a client request. Custom and extended endpoints are scoped as part of your integration work.

Do API calls appear in the audit trail?

Yes. An action taken through the API is recorded the same way as an action taken in the interface, with the calling system, the time and the change.