Skip to content

Customer Identification (KYC) (1.0)

All endpoints related to customer identifications (KYC).

Download OpenAPI description
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/identity/identifications/

Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Returns an array containing all screener hits for a business.

Path
business_idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the hit.

statusstring

Current status of the hit.

check_phrasestring

check phrase submitted

check_eventstring

check initiating event

similaritynumber(float)

match percentage to phrase

first_namestring

first name of match

last_namestring

last name of match

thresholdnumber(float)

threshold of match

aliases_rawstring

match aliases

alternative_spellingstring

match alternate spellings

categorystring

match category

titlestring

match title

sub_categorystring

match subtitle

agestring

match age

date_of_birthstring

YYYY/MM/DD

place_of_birthstring

YYYY/MM/DD

deceased_datestring

YYYY/MM/DD

locationsstring

associated location

countriesstring

associated countries

companiesstring

associated companies

genderstring

gender

further_informationstring

further info

keywordsstring

keywords

enteredstring

date entered in World Checker

updatedstring

date updated in World Checker

deletedstring

date deleted in World Checker

passportsstring

known passports

positionstring

currently held position

remaining_datastring

miscellaneous data

created_atstring(date)

hit created at

updated_atstring(date)

hit updated at

external_sourcesstring

list of all public sources used

age_recorded_atstring

date when age was recorded

worldcheck_idstring

id of worldcheck entry

Response
application/json
{ "id": "string", "status": "string", "check_phrase": "string", "check_event": "string", "similarity": 0.1, "first_name": "string", "last_name": "string", "threshold": 0.1, "aliases_raw": "string", "alternative_spelling": "string", "category": "string", "title": "string", "sub_category": "string", "age": "string", "date_of_birth": "string", "place_of_birth": "string", "deceased_date": "string", "locations": "string", "countries": "string", "companies": "string", "gender": "string", "further_information": "string", "keywords": "string", "entered": "string", "updated": "string", "deleted": "string", "passports": "string", "position": "string", "remaining_data": "string", "created_at": "2019-08-24", "updated_at": "2019-08-24", "external_sources": "string", "age_recorded_at": "string", "worldcheck_id": "string" }