Endpoint Guides

Before calling an endpoint, complete the account, network, credential, and UAT steps in Integration prerequisites.

The endpoints are grouped as follows:

• v2 Endpoints — the older v1/v2 endpoints (mixed XML/JSON contracts, each versioned in its own path, e.g. /getResults/v2), retained for existing integrations only.

• Integration prerequisites
  • Before your first UAT request
  • Credentials and environments
  • Account and product configuration
  • UAT acceptance before Live
  • Client implementation readiness
  • Pre-call checklist
  • Next steps
• v2 Endpoints
  • Endpoint versions
  • Add Applicant
  • Add Application
  • Add Applicant Request
  • Get Result
  • Get Result Report
  • Get Status
  • Get Barred Results