| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version} | ||
|---|---|---|---|
| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version}/{NombreTitular} |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class SearchCountrys(str, Enum):
COLOMBIA = 'Colombia'
COL = 'COL'
MEXICO = 'Mexico'
MEX = 'MEX'
CHILE = 'Chile'
CHL = 'CHL'
BRASIL = 'Brasil'
BRA = 'BRA'
PANAMA = 'Panama'
PAN = 'PAN'
DOMINICANA = 'Dominicana'
DOM = 'DOM'
COSTA_RICA = 'CostaRica'
CRI = 'CRI'
ARGENTINA = 'Argentina'
ARG = 'ARG'
ECUADOR = 'Ecuador'
ECU = 'ECU'
PERU = 'Peru'
PER = 'PER'
EL_SALVADOR = 'ElSalvador'
SLV = 'SLV'
GUATEMALA = 'Guatemala'
GTM = 'GTM'
HONDURAS = 'Honduras'
HND = 'HND'
VENEZUELA = 'Venezuela'
VEN = 'VEN'
ALL = 'ALL'
AFG = 'AFG'
ALB = 'ALB'
DZA = 'DZA'
AND_ = 'AND'
AGO = 'AGO'
ATG = 'ATG'
ARM = 'ARM'
AUS = 'AUS'
AUT = 'AUT'
AZE = 'AZE'
BHS = 'BHS'
BHR = 'BHR'
BGD = 'BGD'
BRB = 'BRB'
BLR = 'BLR'
BEL = 'BEL'
BLZ = 'BLZ'
BEN = 'BEN'
BTN = 'BTN'
BOL = 'BOL'
BIH = 'BIH'
BWA = 'BWA'
BRN = 'BRN'
BGR = 'BGR'
BFA = 'BFA'
BDI = 'BDI'
CPV = 'CPV'
KHM = 'KHM'
CMR = 'CMR'
CAN = 'CAN'
CAF = 'CAF'
TCD = 'TCD'
CHN = 'CHN'
COM = 'COM'
COG = 'COG'
CIV = 'CIV'
HRV = 'HRV'
CUB = 'CUB'
CYP = 'CYP'
CZE = 'CZE'
DNK = 'DNK'
DJI = 'DJI'
DMA = 'DMA'
TLS = 'TLS'
EGY = 'EGY'
GNQ = 'GNQ'
ERI = 'ERI'
EST = 'EST'
ETH = 'ETH'
FJI = 'FJI'
FIN = 'FIN'
FRA = 'FRA'
GAB = 'GAB'
GMB = 'GMB'
GEO = 'GEO'
DEU = 'DEU'
GHA = 'GHA'
GRC = 'GRC'
GRD = 'GRD'
GIN = 'GIN'
GNB = 'GNB'
GUY = 'GUY'
HTI = 'HTI'
HUN = 'HUN'
ISL = 'ISL'
IND = 'IND'
IDN = 'IDN'
IRN = 'IRN'
IRQ = 'IRQ'
IRL = 'IRL'
ISR = 'ISR'
ITA = 'ITA'
JAM = 'JAM'
JPN = 'JPN'
JOR = 'JOR'
KAZ = 'KAZ'
KEN = 'KEN'
KIR = 'KIR'
PRK = 'PRK'
KOR = 'KOR'
KWT = 'KWT'
KGZ = 'KGZ'
LAO = 'LAO'
LVA = 'LVA'
LBN = 'LBN'
LSO = 'LSO'
LBR = 'LBR'
LBY = 'LBY'
LIE = 'LIE'
LTU = 'LTU'
LUX = 'LUX'
MDG = 'MDG'
MWI = 'MWI'
MYS = 'MYS'
MDV = 'MDV'
MLI = 'MLI'
MLT = 'MLT'
MHL = 'MHL'
MRT = 'MRT'
MUS = 'MUS'
FSM = 'FSM'
MDA = 'MDA'
MCO = 'MCO'
MNG = 'MNG'
MNE = 'MNE'
MAR = 'MAR'
MOZ = 'MOZ'
MMR = 'MMR'
NAM = 'NAM'
NRU = 'NRU'
NPL = 'NPL'
NLD = 'NLD'
NZL = 'NZL'
NIC = 'NIC'
NER = 'NER'
NGA = 'NGA'
MKD = 'MKD'
NOR = 'NOR'
OMN = 'OMN'
PAK = 'PAK'
PLW = 'PLW'
PNG = 'PNG'
PRY = 'PRY'
PHL = 'PHL'
POL = 'POL'
PRT = 'PRT'
QAT = 'QAT'
ROU = 'ROU'
RUS = 'RUS'
RWA = 'RWA'
KNA = 'KNA'
LCA = 'LCA'
VCT = 'VCT'
WSM = 'WSM'
SMR = 'SMR'
STP = 'STP'
SAU = 'SAU'
SEN = 'SEN'
SRB = 'SRB'
SYC = 'SYC'
SLE = 'SLE'
SGP = 'SGP'
SVK = 'SVK'
SVN = 'SVN'
SLB = 'SLB'
SOM = 'SOM'
ZAF = 'ZAF'
SSD = 'SSD'
ESP = 'ESP'
LKA = 'LKA'
SDN = 'SDN'
SUR = 'SUR'
SWZ = 'SWZ'
SWE = 'SWE'
CHE = 'CHE'
SYR = 'SYR'
TWN = 'TWN'
TJK = 'TJK'
TZA = 'TZA'
THA = 'THA'
TGO = 'TGO'
TON = 'TON'
TTO = 'TTO'
TUN = 'TUN'
TUR = 'TUR'
TKM = 'TKM'
TUV = 'TUV'
UGA = 'UGA'
UKR = 'UKR'
ARE = 'ARE'
GBR = 'GBR'
USA = 'USA'
URY = 'URY'
UZB = 'UZB'
VUT = 'VUT'
VNM = 'VNM'
YEM = 'YEM'
ZMB = 'ZMB'
ZWE = 'ZWE'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackgroundchekSeach:
api_code: Optional[str] = None
country: Optional[SearchCountrys] = None
document_type: Optional[str] = None
query: Optional[str] = None
version: Optional[int] = None
nombre_titular: Optional[str] = None
class QueryStatus(str, Enum):
OK = 'ok'
FAIL = 'fail'
class Severity(str, Enum):
SUCCESS = 'Success'
INFO = 'Info'
WARNING = 'Warning'
ERROR = 'Error'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Error:
code: Optional[int] = None
message: Optional[str] = None
source: Optional[str] = None
error_severity: Optional[Severity] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DataValue:
order: Optional[int] = None
name: Optional[str] = None
description: Optional[str] = None
tooltip: Optional[str] = None
value: Optional[str] = None
data_type: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FilterEvaluationResults:
matched: Optional[bool] = None
matched_rule: Optional[str] = None
matched_excerpt: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Record:
values: Optional[List[DataValue]] = None
filter_evaluation_result: Optional[FilterEvaluationResults] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DataGroup:
id: Optional[int] = None
name: Optional[str] = None
description: Optional[str] = None
sub_groups: Optional[List[DataGroup]] = None
records: Optional[List[Record]] = None
errors: Optional[List[Error]] = None
parent_group_i_d: Optional[int] = None
validation_group: Optional[bool] = None
risk_points_found: Optional[int] = None
risk_points_not_found: Optional[int] = None
not_found_message: Optional[str] = None
con_coincidencias: Optional[bool] = None
real_points: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackgroundchekReport:
alerts_counter: Optional[int] = None
show_risk_meter: Optional[bool] = None
full_name: Optional[str] = None
document_number: Optional[str] = None
report_date: Optional[datetime.datetime] = None
search_data: Optional[BackgroundchekSeach] = None
search_status: Optional[QueryStatus] = None
report_i_d: Optional[str] = None
errors: Optional[List[Error]] = None
groups: Optional[List[DataGroup]] = None
base_name: Optional[str] = None
resume: Optional[List[str]] = None
max_risk_points: Optional[int] = None
Python BackgroundchekSeach DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}