Sanctions Search API: v2

<back to all web services

GetEulaStatus

Account
The following routes are available for this service:
GET/account/eulaGet the account EULA & status
GetEulaStatus Parameters:
NameParameterData TypeRequiredDescription
SubUserNamequerystringNoIf this is specified, the information will be for the specified sub user, otherwise it will be for the main user account
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).
GetEulaStatusResponse Parameters:
NameParameterData TypeRequiredDescription
DataformGetEulaStatusDataNo
GetEulaStatusData Parameters:
NameParameterData TypeRequiredDescription
TermsAndConditionsformstringNo
PrivacyPolicyformstringNo
AgreeToContactformboolNo
AgreeToContactInfoformstringNo
AgreeToContactDateformDateTime?No
AgreeToTermsformboolNo
AgreeToTermsInfoformstringNo
AgreeToTermsDateformDateTime?No
AgreeToDataProtectionformboolNo
AgreeToDataProtectionInfoformstringNo
AgreeToDataProtectionDateformDateTime?No
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 .xml suffix or ?format=xml

HTTP + XML

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

GET /account/eula HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEulaStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <AgreeToContact>false</AgreeToContact>
    <AgreeToContactDate>0001-01-01T00:00:00</AgreeToContactDate>
    <AgreeToContactInfo>String</AgreeToContactInfo>
    <AgreeToDataProtection>false</AgreeToDataProtection>
    <AgreeToDataProtectionDate>0001-01-01T00:00:00</AgreeToDataProtectionDate>
    <AgreeToDataProtectionInfo>String</AgreeToDataProtectionInfo>
    <AgreeToTerms>false</AgreeToTerms>
    <AgreeToTermsDate>0001-01-01T00:00:00</AgreeToTermsDate>
    <AgreeToTermsInfo>String</AgreeToTermsInfo>
    <PrivacyPolicy>String</PrivacyPolicy>
    <TermsAndConditions>String</TermsAndConditions>
  </Data>
</GetEulaStatusResponse>