Criminal search web service 2 |
|||||||||
Search
Type |
Parameter |
Example |
|||||||
Search By Name |
|||||||||
URL |
https://api.s2verifyconnect.com/ws_criminal3/criminal.svc/xml |
||||||||
Basic
search |
https://api.s2verifyconnect.com/ws_criminal3/criminal.svc/xml?disclaimers_agree=true&account=user&key=password&lastname=white&firstname=john |
||||||||
* Required parameters:disclaimers_agree,
account, key, lastname, firstname |
|||||||||
|
|||||||||
Search By ID (you
can get id and source from index layout search) |
|||||||||
URL |
https://api.s2verifyconnect.com/ws_criminal3/criminal.svc/xml/id |
||||||||
Source/ID
search |
source1
= [Source Name] |
https://api.s2verifyconnect.com/ws_criminal3/criminal.svc/xml/id?disclaimers_agree=true&account=user&key=password&search_type=&source_layout=1&source1=sorca&id1=1869424101075 |
|||||||
Multiple
Source/ID search |
source1/id1 |
https://api.s2verifyconnect.com/ws_criminal3/criminal.svc/xml/id?disclaimers_agree=true&account=user&key=password&source_layout=&source1=ARSTplacerca&id1=0611310%23&source2=sorca&id2=1869424101075&source3=sorhi&id3=A0157139OMAPET&source4=ncaoc&id4=01000ALAMANCE%20%20%20%201978CRS010230&source5=soraz&id5=000299&source6=ipol&id6=2005_45703&source7=ctaoc&id7=W11DCR020114740S&source8=flaoc&id8=52522001MM015789AXXXNO&source9=Rogers.ok&id9=10093034&source10=sc_laurens_circuit&id10=1710162211
|
|||||||
If ID contains URL reserved
characters such as +,?,%,# ,/ and &. Please
encode these special characters as follow: |
|||||||||
|
|||||||||
Layout
parameters |
|||||||||
Choose
Index or source layout |
|
||||||||
Choose
different source layouts (source_type=0) |
|
||||||||
default: search_type=0,source_layout=0 |
|||||||||
Parameters
list
[Required=R] [Optional=O] |
|||||||||
Parameter |
Name |
Desc |
|||||||
R |
Disclaimers_agree |
disclaimers_agree = true (Agree to the term) |
|||||||
R |
account |
Your
account |
|
||||||
R |
key |
Your
password |
|
||||||
R(search
by name) |
lastname |
Offender's
Last name(support wildcard) |
[ex:
smith] [ex: jac* = jackson] |
||||||
R(seach by name) |
firstname |
Offender's
First name (support wildcard) |
[ex:
peter] |
||||||
O |
middlename |
Offender's
middle name(support wildcard) |
[ex:
a] |
||||||
O |
include_partial_middlename |
Include
records with partial or empty middle name |
include_partial_middlename = 1 |
||||||
O |
aka |
Enable
alias names search |
aka =1 |
||||||
O |
zipcode |
Offender's
zip code |
5
digit number |
||||||
O |
state |
US
state |
State
abbreviations ex: CA, OH, VA... default = All . To
specify more than one state, using comma between states such as
CA,HI,AZ |
||||||
O |
category |
record
category |
No specified(Default) = All categories Or
combination of any above category |
||||||
O |
DOB_yyyymmdd |
Offender's
DOB |
DOB
in yyyymmdd format (support wildcard for mmdd) |
||||||
O |
include_partial_DOB |
Include
partial DOB match |
include_partial_DOB = 1 |
||||||
O |
priority_states |
High
priority state(s) |
Records
from these states have high priority. such as priority_states=CA,HI,AZ |
|
|||||
O |
priority_flag |
Return
records in different priority orders |
priority_flag = 0 |
||||||
O |
search_type |
specify
search type |
0:source
table (default) |
||||||
O |
source_layout |
specify
output layout for source table |
0:
unified summary(default) |
||||||
O |
return_index_max |
specify
maximum records returned from the index table (specify range between 1~1000) |
|
||||||
O |
return_source_max |
specify
maximum records returned from the source table (specify range between 1~100) |
|
||||||
O |
all_sor |
Include
Sex Offenders records from all states |
default = false. To enable it, set all_sor
= true |
||||||
O |
all_patriot |
Include
Patriot records from all states |
default = false. To enable it, set all_patriot
= true |
||||||
O |
ref |
Reference |
|||||||
Some
records don't have DOB, if you can't find any record, try to search without
DOB or specify include_NULL_DOB = true |
|||||||||
|
Error
code |
Desc |
I0 |
[Input
error]:Account and password are required |
I1 |
[Input
error]:Lastname and firstname
are required |
I2 |
[Input
error]:Invalid DOB format |
I3 |
[Input
error]:Invalid account or password |
D4 |
[Database
error]:Fail to connect to account db |
I5 |
[Input
error]:'search_type' parameter can only be
0:source,1:index) |
D6 |
[Database
error]:Fail to access source list |
I7 |
[Input
error]:Return_index_max exceeds maximum allowed
records (1~1000) |
I8 |
[Input
error]:Return_source_max exceeds maximum allowed
records (1~100) |
I9 |
[Input
error]:Invalid search category. Please specify
[CR],[SX],[AR],'[WA],[MW],[PA],[ALL],[AR,WA],[CR,SX],[CR,MW],[SX,PA],[CR,SX,MW]
or [CR,SX,PA])(CR=Criminal, SX=Sex Offenders, AR=Arrest, WA=Warrant, MW=Most
wanted, PA=Patriot) |
I10 |
[Input
error]:Invalid 'include_partial_DOB'
value. Value can only be 1,2,3 or 4 |
I11 |
[Input
error]:'DOB_yyyymmdd' is required when 'include_partial_DOB' is specified |
D12 |
[Database
error]: Fail to read the index table |
D13 |
[Database
error]: Fail to read source table(s) |
I14 |
[Input
error]: Parameter 'source_id_array' can only
contains up to maximum allowed [source/id] objects |
I15 |
[Input
error]: Invalid 'source_layout' parameter. Please
specify value range between 0~6 |
I999 |
[Input
error](To use this service, you must agree the term:Please
read Disclaimers section on https://api.s2verifyconnect.com/ws_criminal2 If you
agree the term please reset 'Disclaimers_agree'
parameter in your code = true |
Modify
date |
Desc |
01/28/2010 |
Initial
release (test vertsion) |
02/09/2010 |
source_output_layout = 2 and 3 is available now |
02/09/2010 |
Search
by multiple source/id is available (see 'source_id_array'
parameters) |
02/09/2010 |
New
error message 14 |
03/23/2010 |
New
category (MW = Most Wanted) |
03/23/2010 |
New
parameter (include_partial_middlename) |
08/20/2010 |
New
function, search by SSN |
12/15/2010 |
New
parameters [all_sor] and [all_patriot].
2. New category: [CR,SX,PA] = Criminal + Sex offender + Patriot |
01/31/2011 |
Added
New category (SX,PA = Sex offender + Patriot) |
02/16/2011 |
Added
the error codes table |
03/25/2011 |
Added
layout 6 (unified layout + separated charge info) |
03/25/2011 |
Added
error code I15 |
05/18/2011 |
Added
new partial DOB parameter: include_partial_DOB = 5 |
05/18/2011 |
Combination
of CR,SX,AR,WA,MW and PA are now supported |
07/09/2012 |
Added
Ref parameter |
2010 s2verifydata.com |
Disclaimers
|