Sanctions Search API: v2

GetClients

Clients

The following routes are available for this service:
GET	/clients	Get all clients

**GetClients** Parameters:
Name	Parameter	Data Type	Required	Description
State	query	ClientState	No	Filter the results to those that have a State matching the state specified
IsValidateMe	query	bool?	No	Filter the results to those that have a IsValidateMe flag matching the specified value
Name	query	string	No	Filter the results to those that have a Name including the specified value
DateFrom	query	DateTime	No	Filter the results to those that were created after (or on) this date
DateTo	query	DateTime	No	Filter the results to those that were created before this date
SubUserName	query	string	No	If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view

**PagedRequest** Parameters:
Name	Parameter	Data Type	Required	Description
PageLimit	query	int	No	The maximum number of records to be returned in one page
PageOffset	query	int	No	The starting point in the list of records from where the data should be fetched. Zero based index.
Sort	query	string	No	The term to determine the order in which the data is returned

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	The API User ID provided by us when you signed up to use our API
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API

**ClientState** Enum:
Undefined
PendingCompletion
PendingOcr
PendingVerification
Verified

**GetClientsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetClientsData	No

**GetClientsData** Parameters:
Name	Parameter	Data Type	Required	Description
Clients	form	ArrayOfClientShort	No

**PagedResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Meta	form	Meta<T>	No	The response Metadata

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

**Meta<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Links	form	MetaLinks	No	Pagination links
TotalCount	form	int?	No	The total number of records for the query
PageLimit	form	int?	No	The maximum number of records to be returned in one page
PageOffset	form	int?	No	The starting point in the list of records from where the data should be fetched. Zero based index.

**MetaLinks** Parameters:
Name	Parameter	Data Type	Required	Description
First	form	string	No	The link to the first page of records
Last	form	string	No	The link to the last page of records
Next	form	string	No	The link to the next page of records, if applicable
Prev	form	string	No	The link to the last page of records, if applicable

**Links** Parameters:
Name	Parameter	Data Type	Required	Description
Self	form	string	No

**ClientShort** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
DateCreated	form	DateTime	No
Name	form	string	No
Reference	form	string	No
IsValidateMe	form	bool	No
State	form	ClientState	No
Links	form	Links	No
NumOfDocuments	form	int	No
Photo	form	Image	No

**Image** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
OcrId	form	int?	No
Url	form	string	No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /clients HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"clients":[{"id":0,"dateCreated":"\/Date(-62135596800000-0000)\/","name":"String","reference":"String","isValidateMe":false,"state":"Undefined","links":{"self":"String"},"numOfDocuments":0,"photo":{"id":0,"name":"String","ocrId":0,"url":"String"}}],"meta":{"links":{"first":"String","last":"String","next":"String","prev":"String","self":"String"},"totalCount":0,"pageLimit":0,"pageOffset":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}