APIbackgroundchecklatam

BackgroundchekSeach

The following routes are available for this service:
All Verbs	/BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version}
All Verbs	/BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version}/{NombreTitular}

**BackgroundchekSeach** Parameters:
Name	Parameter	Data Type	Required
ApiCode	path	string	No
Country	path	SearchCountrys	No
DocumentType	path	string	No
Query	path	string	No
Version	path	int	No
NombreTitular	path	string	No

**SearchCountrys** Enum:
Colombia
COL
Mexico
MEX
Chile
CHL
Brasil
BRA
Panama
PAN
Dominicana
DOM
CostaRica
CRI
Argentina
ARG
Ecuador
ECU
Peru
PER
ElSalvador
SLV
Guatemala
GTM
Honduras
HND
Venezuela
VEN
ALL
AFG
ALB
DZA
AND
AGO
ATG
ARM
AUS
AUT
AZE
BHS
BHR
BGD
BRB
BLR
BEL
BLZ
BEN
BTN
BOL
BIH
BWA
BRN
BGR
BFA
BDI
CPV
KHM
CMR
CAN
CAF
TCD
CHN
COM
COG
CIV
HRV
CUB
CYP
CZE
DNK
DJI
DMA
TLS
EGY
GNQ
ERI
EST
ETH
FJI
FIN
FRA
GAB
GMB
GEO
DEU
GHA
GRC
GRD
GIN
GNB
GUY
HTI
HUN
ISL
IND
IDN
IRN
IRQ
IRL
ISR
ITA
JAM
JPN
JOR
KAZ
KEN
KIR
PRK
KOR
KWT
KGZ
LAO
LVA
LBN
LSO
LBR
LBY
LIE
LTU
LUX
MDG
MWI
MYS
MDV
MLI
MLT
MHL
MRT
MUS
FSM
MDA
MCO
MNG
MNE
MAR
MOZ
MMR
NAM
NRU
NPL
NLD
NZL
NIC
NER
NGA
MKD
NOR
OMN
PAK
PLW
PNG
PRY
PHL
POL
PRT
QAT
ROU
RUS
RWA
KNA
LCA
VCT
WSM
SMR
STP
SAU
SEN
SRB
SYC
SLE
SGP
SVK
SVN
SLB
SOM
ZAF
SSD
ESP
LKA
SDN
SUR
SWZ
SWE
CHE
SYR
TWN
TJK
TZA
THA
TGO
TON
TTO
TUN
TUR
TKM
TUV
UGA
UKR
ARE
GBR
USA
URY
UZB
VUT
VNM
YEM
ZMB
ZWE

**BackgroundchekReport** Parameters:
Name	Parameter	Data Type	Required
AlertsCounter	form	int	No
ShowRiskMeter	form	bool	No
FullName	form	string	No
DocumentNumber	form	string	No
ReportDate	form	DateTime	No
SearchData	form	BackgroundchekSeach	No
SearchStatus	form	QueryStatus	No
ReportID	form	string	No
Errors	form	List<Error>	No
Groups	form	List<DataGroup>	No
baseName	form	string	No
Resume	form	List<string>	No
MaxRiskPoints	form	int	No

**QueryStatus** Enum:
ok
fail

**Error** Parameters:
Name	Parameter	Data Type	Required
Code	form	int	No
Message	form	string	No
Source	form	string	No
ErrorSeverity	form	Severity	No

**Severity** Enum:
Success
Info
Warning
Error

**DataGroup** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Description	form	string	No
SubGroups	form	List<DataGroup>	No
Records	form	List<Record>	No
Errors	form	List<Error>	No
ParentGroupID	form	int	No
ValidationGroup	form	bool	No
RiskPointsFound	form	int	No
RiskPointsNotFound	form	int	No
NotFoundMessage	form	string	No
ConCoincidencias	form	bool	No
RealPoints	form	int	No

**Record** Parameters:
Name	Parameter	Data Type	Required	Description
Values	form	List<DataValue>	No
FilterEvaluationResult	form	FilterEvaluationResults	No

**DataValue** Parameters:
Name	Parameter	Data Type	Required
Order	form	int	No
Name	form	string	No
Description	form	string	No
Tooltip	form	string	No
Value	form	string	No
DataType	form	string	No

**FilterEvaluationResults** Parameters:
Name	Parameter	Data Type	Required
Matched	form	bool	No
MatchedRule	form	string	No
MatchedExcerpt	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version} HTTP/1.1 
Host: api.backgroundchecklatam.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiCode: String,
	Country: Colombia,
	DocumentType: String,
	Query: String,
	Version: 0,
	NombreTitular: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	AlertsCounter: 0,
	ShowRiskMeter: False,
	FullName: String,
	DocumentNumber: String,
	ReportDate: 0001-01-01,
	SearchData: 
	{
		ApiCode: String,
		Country: Colombia,
		DocumentType: String,
		Query: String,
		Version: 0,
		NombreTitular: String
	},
	SearchStatus: ok,
	ReportID: String,
	Errors: 
	[
		{
			Code: 0,
			Message: String,
			Source: String,
			ErrorSeverity: Success
		}
	],
	Groups: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			SubGroups: 
			[
				{
					Id: 0,
					Name: String,
					Description: String,
					SubGroups: 
					[
						{
							Id: 0,
							Name: String,
							Description: String,
							Records: 
							[
								{
									Values: 
									[
										{
											Order: 0,
											Name: String,
											Description: String,
											Tooltip: String,
											Value: String,
											DataType: String
										}
									],
									FilterEvaluationResult: 
									{
										Matched: False,
										MatchedRule: String,
										MatchedExcerpt: String
									}
								}
							],
							Errors: 
							[
								{
									Code: 0,
									Message: String,
									Source: String,
									ErrorSeverity: Success
								}
							],
							ParentGroupID: 0,
							ValidationGroup: False,
							RiskPointsFound: 0,
							RiskPointsNotFound: 0,
							NotFoundMessage: String,
							ConCoincidencias: False,
							RealPoints: 0
						}
					],
					Records: 
					[
						{
							Values: 
							[
								{
									Order: 0,
									Name: String,
									Description: String,
									Tooltip: String,
									Value: String,
									DataType: String
								}
							],
							FilterEvaluationResult: 
							{
								Matched: False,
								MatchedRule: String,
								MatchedExcerpt: String
							}
						}
					],
					Errors: 
					[
						{
							Code: 0,
							Message: String,
							Source: String,
							ErrorSeverity: Success
						}
					],
					ParentGroupID: 0,
					ValidationGroup: False,
					RiskPointsFound: 0,
					RiskPointsNotFound: 0,
					NotFoundMessage: String,
					ConCoincidencias: False,
					RealPoints: 0
				}
			],
			Records: 
			[
				{
					Values: 
					[
						{
							Order: 0,
							Name: String,
							Description: String,
							Tooltip: String,
							Value: String,
							DataType: String
						}
					],
					FilterEvaluationResult: 
					{
						Matched: False,
						MatchedRule: String,
						MatchedExcerpt: String
					}
				}
			],
			Errors: 
			[
				{
					Code: 0,
					Message: String,
					Source: String,
					ErrorSeverity: Success
				}
			],
			ParentGroupID: 0,
			ValidationGroup: False,
			RiskPointsFound: 0,
			RiskPointsNotFound: 0,
			NotFoundMessage: String,
			ConCoincidencias: False,
			RealPoints: 0
		}
	],
	baseName: String,
	Resume: 
	[
		String
	],
	MaxRiskPoints: 0
}