Sanctions Search API: v2

ActivateValidId

ValidID

The following routes are available for this service:
POST	/validid/activate	Activate ValidID

**ActivateValidId** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	ActivateValidIdRequest	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

**ActivateValidIdRequest** Parameters:
Name	Parameter	Data Type	Required
CompanyName	form	string	No
CompanyAddress	form	string	No
CompanyNumber	form	string	No
Name	form	string	No
Position	form	string	No
Signature	form	string	No
DPANumber	form	string	No
AMLBodyNumber	form	string	No
Purpose	form	string	No
ClassificationId	form	int	No
AgreeToTerms	form	bool	No

**ActivateValidIdResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	ActivateValidIdData	No

**ActivateValidIdData** Parameters:
Name	Parameter	Data Type	Required	Description
ValidIdActivated	form	bool	No
AgreementText	form	string	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.

POST /validid/activate HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"companyName":"String","companyAddress":"String","companyNumber":"String","name":"String","position":"String","signature":"String","dpaNumber":"String","amlBodyNumber":"String","purpose":"String","classificationId":0,"agreeToTerms":false},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

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