Sanctions Search API: v2

<back to all web services

ActivateValidId

ValidID
The following routes are available for this service:
POST/validid/activateActivate ValidID
ActivateValidId Parameters:
NameParameterData TypeRequiredDescription
RequestbodyActivateValidIdRequestNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
Authenticationheader, bodyAuthenticationYesThe authentication credentials
Authentication Parameters:
NameParameterData TypeRequiredDescription
ApiUserIdheader, bodystringYesThe API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
ApiUserKeyheader, bodystringYesThe API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
UserIdheader, bodystringNoThe User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
ActivateValidIdRequest Parameters:
NameParameterData TypeRequiredDescription
CompanyNameformstringNo
CompanyAddressformstringNo
CompanyNumberformstringNo
NameformstringNo
PositionformstringNo
SignatureformstringNo
DPANumberformstringNo
AMLBodyNumberformstringNo
PurposeformstringNo
ClassificationIdformintNo
AgreeToTermsformboolNo
ActivateValidIdResponse Parameters:
NameParameterData TypeRequiredDescription
DataformActivateValidIdDataNo
ActivateValidIdData Parameters:
NameParameterData TypeRequiredDescription
ValidIdActivatedformboolNo
AgreementTextformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNoThe status of the response
ResponseStatus Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StackTraceformstringNo
ErrorsformArrayOfResponseErrorNo
MetaformDictionary<string, string>No
ResponseError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
FieldNameformstringNo
MessageformstringNo
MetaformDictionary<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","userId":"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"}}}}