Siork API (2020-07-27T02:15:28Z)

Download OpenAPI specification:Download

Authentication

api_key

Security Scheme Type	API Key
Header parameter name:	x-api-key

Search Name

Authorizations:

api_key

header Parameters

x-api-key

required

string

Request Body schema: application/json

entries required	Array of objects (SearchEntry) [ 1 .. 10 ] items Entries to search.
searchConfig required	object (SearchConfig)
requestId	string <= 256 characters Request ID specified by client.

Responses

200

Search Result

post /search

https://api.service.siork.com/v1/search

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"entries": 
[
{"names": 
[
{"fullName": "string"
}
],
"ids": 
[
{"idType": "P",
"idValue": "string",
"idCountry": "st"
}
],
"gender": "M",
"nationality": "string",
"citizenship": "string",
"addressCountry": "string",
"searchEntryId": "string",
"dateOfBirth": 
{"year": "stri",
"month": "st",
"day": "st"
}
}
],
"searchConfig": 
{"listFilter": 
{"entityTypes": 
["P"
],
"targets": 
[
{"listId": "string",
"excludes": 
["string"
]
}
],
"scope": 
{"type": "FULL",
"listDateOn": 0,
"listDateFrom": 0,
"listDateTo": 0
}
},
"discounts": 
{"factors": 
[
{"factor": "DOB",
"active": true,
"scores": 
[
{"type": "MATCH",
"score": 0
}
]
}
]
},
"threshold": 0.6
},
"requestId": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"referenceId": "string",
"requestTime": 0,
"requestId": "string",
"matches": 
[
{"score": 0,
"listId": "string",
"entryId": "string",
"listName": "string",
"listEntry": 
{"listId": "OFAC_SDN",
"publishDate": 0,
"updateDate": 0,
"endDate": 0,
"entryId": "string",
"entityType": "string",
"categories": 
["string"
],
"names": 
[
{"nameType": "string",
"fullName": "string"
}
],
"gender": "string",
"dateOfBirths": 
[
{"year": "stri",
"month": "st",
"day": "st",
"from": 
{"year": "stri",
"month": "st",
"day": "st"
},
"to": 
{"year": "stri",
"month": "st",
"day": "st"
}
}
],
"placeOfBirths": 
["string"
],
"nationalities": 
["string"
],
"citizenships": 
["string"
],
"addresses": 
[
{"poBox": "string",
"addressLine": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}
],
"ids": 
[
{"idType": "string",
"idSubType": "string",
"idValue": "string",
"idCountry": "string",
"issueDate": 
{"year": "stri",
"month": "st",
"day": "st"
},
"validFrom": 
{"year": "stri",
"month": "st",
"day": "st"
},
"validTo": 
{"year": "stri",
"month": "st",
"day": "st"
}
}
],
"info": "string",
"vessel": 
{"callSign": "string",
"vesselType": "string",
"vesselFlag": "string",
"vesselOwner": "string",
"tonnage": 0,
"grossRegisteredTonnage": 0
}
},
"matches": 
[
{"matchType": "ID",
"score": 0,
"searchValue": "string",
"matchValue": "string"
}
],
"discounts": 
[
{"factor": "FULLNAME",
"type": "MATCH",
"score": 0
}
],
"searchEntryId": "string"
}
]
}

Search Option

Authorizations:

api_key

header Parameters

x-api-key

required

string

Responses

200

Search Option

get /search/option

https://api.service.siork.com/v1/search/option

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"listInfos": 
[
{"listId": "string",
"lastUpdateDate": 0,
"lastPublishDate": 0,
"categories": 
["string"
]
}
]
}

Identify Face

Authorizations:

api_key

header Parameters

x-api-key

required

string

Request Body schema: application/json

imagePair required	object (ImagePair)
requestId	string <= 256 characters Request ID specified by client.

Responses

200

Identify Result

post /identify/face

https://api.service.siork.com/v1/identify/face

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"imagePair": 
{"image1": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAADwCAYAAABxLb1r...",
"image2": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAADwCAYAAABxLb1r..."
},
"requestId": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"referenceId": "string",
"requestTime": 0,
"requestId": "string",
"result": 
{"difference": 0
}
}