Introduction

To use RecordsAPI, 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.

 

BIRTH

OUTPUT EXAMPLES(XML) WITH XML REQUEST SCHEMA

http://api.recordsapi.com/v2/xml.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. BIRTH). (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)
BirthYear Year of Birth (Ex. 1850) (Optional)
FamilyName Family Name (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. For more information about response XML elements follow API USER MANUAL.

SAMPLE REQUEST (XML) - BIRTH

SAMPLE RESPONSE (XML) - BIRTH

DEATH

OUTPUT EXAMPLES(XML) WITH XML REQUEST SCHEMA

http://api.recordsapi.com/v2/xml.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. BIRTH). (Mandatory)
data FirstName First name of the person (Ex. Dillon) (Optional)
LastName Last name of the person (Ex. Lillian) (Mandatory)
MiddleName Middle name of the person (Ex. J) (Optional)
State Name of the State of US. (Ex. Alabama or FL). (Mandatory if County is Specified.)
County Name of the County of the State. (Optional)
BirthYear Year of Birth (Ex. 1902) (Optional)
DeathYear Year of Birth (Ex. 2006) (Optional)
FamilyName Family Name (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. Death Database is also merged with cemetery/grave records database. In some cases if Death record is not matched with the request pattern, the interface will return data from cemetery/grave database automatically. For more information about response XML elements follow API USER MANUAL.

SAMPLE REQUEST (XML) - DEATH

SAMPLE RESPONSE (XML) - DEATH

CEMETERY/GRAVE

OUTPUT EXAMPLES(XML) WITH XML REQUEST SCHEMA

http://api.recordsapi.com/v2/xml.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. BIRTH). (Mandatory)
data FirstName First name of the person (Ex. Dillon) (Optional)
LastName Last name of the person (Ex. Lillian) (Mandatory)
MiddleName Middle name of the person (Ex. J) (Optional)
State Name of the State of US. (Ex. Alabama or FL). (Mandatory if County is Specified.)
County Name of the County of the State. (Optional)
BirthYear Year of Birth (Ex. 1902) (Optional)
DeathYear Year of Birth (Ex. 2006) (Optional)
FamilyName Family Name (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. Death Database is also merged with cemetery/grave records database. In some cases if Death record is not matched with the request pattern, the interface will return data from cemetery/grave database automatically. For more information about response XML elements follow API USER MANUAL.

SAMPLE REQUEST (XML) - CEMETERY/GRAVE (SAME AS DEATH)

SAMPLE RESPONSE (XML) - CEMETERY/GRAVE

MARRIAGE

OUTPUT EXAMPLES(XML) WITH XML REQUEST SCHEMA

http://api.recordsapi.com/v2/xml.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. MARRIAGE). (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. D) (Optional)
State Name of the State of US. (Ex. Alabama or FL). (Mandatory if County is Specified.)
County Name of the County of the State. (Optional)
MarriageYear Year of Marriage (Ex. 2015) (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. For more information about response XML elements follow API USER MANUAL.

SAMPLE REQUEST (XML) - MARRIAGE

SAMPLE RESPONSE (XML) - MARRIAGE

DIVORCE

OUTPUT EXAMPLES(XML) WITH XML REQUEST SCHEMA

http://api.recordsapi.com/v2/xml.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. DIVORCE). (Mandatory)
data FirstName First name of the person (Ex. Sheila Y) (Optional)
LastName Last name of the person (Ex. Smith) (Mandatory)
MiddleName Middle name of the person (Ex. D) (Optional)
State Name of the State of US. (Ex. Texas or AL). (Mandatory if County is Specified.)
County Name of the County of the State. (Optional)
MarriageYear Year of Marriage (Ex. 1991) (Optional)
DivorceYear Year of Divorce (Ex. 1991) (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. For more information about response XML elements follow API USER MANUAL.

SAMPLE REQUEST (XML) - DIVORCE

SAMPLE RESPONSE (XML) - DIVORCE

US PEOPLE

OUTPUT EXAMPLES(XML) WITH XML REQUEST SCHEMA

http://api.recordsapi.com/v2/xml.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. USPEOPLE). (Mandatory)
data Name Name of the person (Ex. Elizabeth) (Mandatory)
State Name of the State of US. (Ex. Alabama or TX). (Mandatory if County is Specified.)
County Name of the County of the State. (Optional)
City Name of the City. (Optional)
Zipcode Zipcode (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: For more information about response XML elements follow API USER MANUAL.

SAMPLE REQUEST (XML) - US PEOPLE

SAMPLE RESPONSE (XML) - US PEOPLE

US BUSINESS

OUTPUT EXAMPLES(XML) WITH XML REQUEST SCHEMA

http://api.recordsapi.com/v2/xml.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. USBUSINESS). (Mandatory)
data Business Name of the business (Ex. Adoption) (Mandatory)
State Name of the State of US. (Ex. Georgia or FL). (Mandatory if County is Specified.)
County Name of the County of the State. (Optional)
City Name of the City. (Optional)
Zipcode Zipcode (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: For more information about response XML elements follow API USER MANUAL.

SAMPLE REQUEST (XML) - US BUSINESS

SAMPLE RESPONSE (XML) - US BUSINESS

JSON

 

 

BIRTH

OUTPUT EXAMPLES(JSON) WITH JSON REQUEST SCHEMA

http://api.recordsapi.com/v2/json.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. BIRTH). (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)
BirthYear Year of Birth (Ex. 1850) (Optional)
FamilyName Family Name (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. For more information about response JSON elements follow API USER MANUAL.

SAMPLE REQUEST (JSON) - BIRTH

SAMPLE RESPONSE (JSON) - BIRTH

DEATH

OUTPUT EXAMPLES(JSON) WITH JSON REQUEST SCHEMA

http://api.recordsapi.com/v2/json.phpvia HTTP 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 Database Name/Record Type In Uppercase. (Ex. BIRTH). (Mandatory)
data FirstName First name of the person (Ex. Dillon) (Optional)
LastName Last name of the person (Ex. Lillian) (Mandatory)
MiddleName Middle name of the person (Ex. J) (Optional)
State Name of the State of US. (Ex. Alabama or FL). (Mandatory if County is Specified.)
County Name of the County of the State. (Optional)
BirthYear Year of Birth (Ex. 1902) (Optional)
DeathYear Year of Birth (Ex. 2006) (Optional)
FamilyName Family Name (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. Death Database is also merged with cemetery/grave records database. In some cases if Death record is not matched with the request pattern, the interface will return data from cemetery/grave database automatically. For more information about response JSON elements follow API USER MANUAL.

SAMPLE REQUEST (JSON) - DEATH

SAMPLE RESPONSE (JSON) - DEATH

CEMETERY/GRAVE

OUTPUT EXAMPLES(JSON) WITH JSON REQUEST SCHEMA

http://api.recordsapi.com/v2/json.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. BIRTH). (Mandatory)
data FirstName First name of the person (Ex. Dillon) (Optional)
LastName Last name of the person (Ex. Lillian) (Mandatory)
MiddleName Middle name of the person (Ex. J) (Optional)
State Name of the State of US. (Ex. Alabama or FL). (Mandatory if County is Specified.)
County Name of the County of the State. (Optional)
BirthYear Year of Birth (Ex. 1902) (Optional)
DeathYear Year of Birth (Ex. 2006) (Optional)
FamilyName Family Name (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. Death Database is also merged with cemetery/grave records database. In some cases if Death record is not matched with the request pattern, the interface will return data from cemetery/grave database automatically. For more information about response JSON elements follow API USER MANUAL.

SAMPLE REQUEST (JSON) - CEMETERY/GRAVE (SAME AS DEATH)

SAMPLE RESPONSE (JSON) - CEMETERY/GRAVE

marriage

OUTPUT EXAMPLES(JSON) WITH JSON REQUEST SCHEMA

http://api.recordsapi.com/v2/json.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. BIRTH). (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)
BirthYear Year of Birth (Ex. 1850) (Optional)
FamilyName Family Name (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. For more information about response JSON elements follow API USER MANUAL.

SAMPLE REQUEST (JSON) - marriage

SAMPLE RESPONSE (JSON) - marriage

divorce

OUTPUT EXAMPLES(JSON) WITH JSON REQUEST SCHEMA

http://api.recordsapi.com/v2/json.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. BIRTH). (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)
BirthYear Year of Birth (Ex. 1850) (Optional)
FamilyName Family Name (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. For more information about response JSON elements follow API USER MANUAL.

SAMPLE REQUEST (JSON) - divorce

SAMPLE RESPONSE (JSON) - divorce

us people

OUTPUT EXAMPLES(JSON) WITH JSON REQUEST SCHEMA

http://api.recordsapi.com/v2/json.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. USPEOPLE). (Mandatory)
data Business First name of the person (Ex. Mary) (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 City. (Optional)
Zipcode Zipcode. (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. For more information about response JSON elements follow API USER MANUAL.

SAMPLE REQUEST (JSON) - us people

SAMPLE RESPONSE (JSON) - us people

us business

OUTPUT EXAMPLES(JSON) WITH JSON REQUEST SCHEMA

http://api.recordsapi.com/v2/json.php via HTTP 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 Database Name/Record Type In Uppercase. (Ex. USBUSINESS). (Mandatory)
data Business First name of the person (Ex. Mary) (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 City. (Optional)
Zipcode Zipcode. (Optional)
ExactMatch Yes/No/Blank (Optional) Default - No

Note: The response includes Name and Meaning & Vital Records Office Addresses. For more information about response JSON elements follow API USER MANUAL.

>

SAMPLE REQUEST (JSON) - us business

SAMPLE RESPONSE (JSON) - us business