Sanctions Search API: v2

ArchivePepSearch

PEP

The following routes are available for this service:
PUT	/peps/archive	Archive an existing PEP search

**ArchivePepSearch** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	ArchivePepSearchRequest	No

**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

**ArchivePepSearchRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	long	No

**ArchivePepSearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	ArchivePepSearchData	No

**ArchivePepSearchData** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No

**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

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.

PUT /peps/archive HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"success":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}