Version 2
Introduction

Output Examples (XML)

BACKGROUND

Output Examples (JSON)

BACKGROUND API User Manual

Introduction

To use Background Check API, you should follow the general syntax. In this document (XML / JSON OUTPUT EXAMPLES WITH REQUEST SCHEMA), you will find the input XML schema with the associate output in XML for all the records type (catalogue) supported by Records API version 2. For more information about response XML elements follow API USER MANUAL.

 

BACKGROUND

OUTPUT EXAMPLES(XML) WITH XML REQUEST SCHEMA

http://xmlapi.backgroundcheckapi.com/ via HTTP(V 1.1) POST Method.

DESCRIPTION OF XML REQUEST ELEMENTS

Root Element Child Element Element Value
credentials App_ID Records API Unique App ID. (Mandatory)
App_Key Records API Unique App Key. (Mandatory)
Timestamp Current Timestamp at the time of request. (Optional)
catalogue BACKGROUND. (Mandatory)
data FirstName First name of the person (Ex. Mary) (Optional)
LastName Last name of the person (Ex. Victor) (Mandatory)
MiddleName Middle name of the person (Ex. C) (Optional)
State Name of the State of US. (Ex. Alabama or AL). (Mandatory)
County Name of the County of the State. (Ex. Autauga) (Optional)
City Name of the City. (Ex. Lake) (Optional)
BirthYear Year of Birth (Ex. 1850) (Optional)
CrimeType Inmate Or Offender Or Released Inmate Or Warrant (Optional. For all types left this field blank.)
ExactMatch Yes/No/Blank (Optional) Default - No

HTTP(V 1.1) GET Method.

http://xmlapi.backgroundcheckapi.com/?App_ID=[BACKGROUND CHECK API APP ID]&App_Key=[BACKGROUND CHECK API APP KEY]&Timestamp=[CURRENT TIMESTAMP]&IP=[IP]&catalogue=BACKGROOUND&FirstName= Neal Anderson &LastName= Stanford &MiddleName=&State= Washington &County= Benton &City= STEILACOOM &BirthYear=&CrimeType=&ExactMatch=Yes

SAMPLE REQUEST (XML) - BACKGROUND

SAMPLE RESPONSE (XML) - BACKGROUND

JSON

 

 

BACKGROUND

OUTPUT EXAMPLES(JSON) WITH JSON REQUEST SCHEMA

http://apijson.backgroundcheckapi.com/ via HTTP (V 1.1) POST Method.

DESCRIPTION OF JSON REQUEST ELEMENTS

Root Element Child Element Element Value
credentials App_ID Records API Unique App ID. (Mandatory)
App_Key Records API Unique App Key. (Mandatory)
Timestamp Current Timestamp at the time of request. (Optional)
catalogue BACKGROUND. (Mandatory)
data FirstName First name of the person (Ex. Mary) (Optional)
LastName Last name of the person (Ex. Victor) (Mandatory)
MiddleName Middle name of the person (Ex. C) (Optional)
State Name of the State of US. (Ex. Alabama or AL). (Mandatory)
County Name of the County of the State. (Ex. Autauga) (Optional)
City Name of the City. (Ex. Lake) (Optional)
BirthYear Year of Birth (Ex. 1850) (Optional)
CrimeType Inmate Or Offender Or Released Inmate Or Warrant (Optional. For all types left this field blank.)
ExactMatch Yes/No/Blank (Optional) Default - No

HTTP(V 1.1) GET Method.

http://jsonapi.backgroundcheckapi.com/?App_ID=[BACKGROUND CHECK API APP ID]&App_Key=[BACKGROUND CHECK API APP KEY]&Timestamp=[CURRENT TIMESTAMP]&IP=[IP]&catalogue=BACKGROOUND&FirstName= Neal Anderson &LastName= Stanford &MiddleName=&State= Washington &County= Benton &City= STEILACOOM &BirthYear=&CrimeType=&ExactMatch=Yes

SAMPLE REQUEST (JSON) - BACKGROUND

SAMPLE RESPONSE (JSON) - BACKGROUND