| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version} | ||
|---|---|---|---|
| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version}/{NombreTitular} |
export enum SearchCountrys
{
Colombia = 'Colombia',
COL = 'COL',
Mexico = 'Mexico',
MEX = 'MEX',
Chile = 'Chile',
CHL = 'CHL',
Brasil = 'Brasil',
BRA = 'BRA',
Panama = 'Panama',
PAN = 'PAN',
Dominicana = 'Dominicana',
DOM = 'DOM',
CostaRica = 'CostaRica',
CRI = 'CRI',
Argentina = 'Argentina',
ARG = 'ARG',
Ecuador = 'Ecuador',
ECU = 'ECU',
Peru = 'Peru',
PER = 'PER',
ElSalvador = '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',
}
export class BackgroundchekSeach
{
public ApiCode?: string;
public Country?: SearchCountrys;
public DocumentType?: string;
public Query?: string;
public Version?: number;
public NombreTitular?: string;
public constructor(init?: Partial<BackgroundchekSeach>) { (Object as any).assign(this, init); }
}
export enum QueryStatus
{
ok = 'ok',
fail = 'fail',
}
export enum Severity
{
Success = 'Success',
Info = 'Info',
Warning = 'Warning',
Error = 'Error',
}
export class Error
{
public Code?: number;
public Message?: string;
public Source?: string;
public ErrorSeverity?: Severity;
public constructor(init?: Partial<Error>) { (Object as any).assign(this, init); }
}
export class DataValue
{
public Order?: number;
public Name?: string;
public Description?: string;
public Tooltip?: string;
public Value?: string;
public DataType?: string;
public constructor(init?: Partial<DataValue>) { (Object as any).assign(this, init); }
}
export class FilterEvaluationResults
{
public Matched?: boolean;
public MatchedRule?: string;
public MatchedExcerpt?: string;
public constructor(init?: Partial<FilterEvaluationResults>) { (Object as any).assign(this, init); }
}
export class Record
{
public Values?: DataValue[];
public FilterEvaluationResult?: FilterEvaluationResults;
public constructor(init?: Partial<Record>) { (Object as any).assign(this, init); }
}
export class DataGroup
{
public Id?: number;
public Name?: string;
public Description?: string;
public SubGroups?: DataGroup[];
public Records?: Record[];
public Errors?: Error[];
public ParentGroupID?: number;
public ValidationGroup?: boolean;
public RiskPointsFound?: number;
public RiskPointsNotFound?: number;
public NotFoundMessage?: string;
public ConCoincidencias?: boolean;
public RealPoints?: number;
public constructor(init?: Partial<DataGroup>) { (Object as any).assign(this, init); }
}
export class BackgroundchekReport
{
public AlertsCounter?: number;
public ShowRiskMeter?: boolean;
public FullName?: string;
public DocumentNumber?: string;
public ReportDate?: string;
public SearchData?: BackgroundchekSeach;
public SearchStatus?: QueryStatus;
public ReportID?: string;
public Errors?: Error[];
public Groups?: DataGroup[];
public baseName?: string;
public Resume?: string[];
public MaxRiskPoints?: number;
public constructor(init?: Partial<BackgroundchekReport>) { (Object as any).assign(this, init); }
}
TypeScript BackgroundchekSeach DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"ApiCode":"String","Country":"Colombia","DocumentType":"String","Query":"String","Version":0,"NombreTitular":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"AlertsCounter":0,"ShowRiskMeter":false,"FullName":"String","DocumentNumber":"String","ReportDate":"\/Date(-62135596800000-0000)\/","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}