⚡ API Access

Free API Integration Documentation

Endpoint for processing an "input" value through an "api" gateway.

Get

/TryNow?handler=OnGetAsync&input={input}&gateway=api

The TryNow API accepts an input value and a gateway identifier. The server processes the input using the "api" gateway and returns the matching results as JSON with http response code.

Property Value
HTTP Method GET
Endpoint /TryNow?handler=OnGetAsyn
Content Type application/json
Authentication None
Successful Response 200 OK
Client Error 400 Bad Request
Server Error 500 Internal Server Error
Server Error 503 Service Unavailable. Data refreshing

Query Parameters

Parameter Type Required Description Constraints
input string Yes The screening input. Minimum length: 1
Maximum length: 200
gateway string Yes Default gateway value. Allowed values: api

Example Request

GET /TryNow?handler=OnGetAsync&input=Doe%20Jone&gateway=api

cURL

curl https://www.assentpro.com/TryNow?handler=OnGetAsync&input=Doe%20Jone&gateway=api

Validation Rules

  • input must be provided.
  • input must not be empty.
  • input must not exceed 200 characters.
  • gateway must be provided.
  • gateway must have default "api" value.
  • Query-string values must be URL encoded.

Responses

200 OK

Field Type Description
input string The input supplied by the client.
screeningResponse string array All matching results ordered by match percentage.
history object Last 7 input values.
                

400 BAD REQUEST, 500 INTERNAL SERVER ERROR, 503 SERVICE UNAVAILABLE

Field Type Description
error code string The http error response code .
description string Error brief description.
                

HTTP Status Codes

Status Name Description
200 OK Input was successfully processed.
400 Bad Request One or more query parameters are invalid or daily free max limit exceeded.
500 Internal Server Error An unexpected server-side error occurred.
503 Service Unavailable Data Refreshing.

Additional Notes

Query-string parameters containing spaces, special characters, or reserved URL characters must be URL encoded.