Sanctions Search API: v2

<back to all web services

ActivateValidId

"use strict";
export class Authentication {
    /** @param {{apiUserId?:string,apiUserKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API User ID provided by us when you signed up to use our API */
    apiUserId;
    /**
     * @type {string}
     * @description The API User Key provided by us when you signed up to use our API */
    apiUserKey;
}
export class BaseRequest {
    /** @param {{authentication?:Authentication}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Authentication}
     * @description The authentication credentials */
    authentication;
}
export class ResponseError {
    /** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    fieldName;
    /** @type {string} */
    message;
    /** @type {{ [index: string]: string; }} */
    meta;
}
export class ArrayOfResponseError extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
    /** @param {{errorCode?:string,message?:string,stackTrace?:string,errors?:ArrayOfResponseError,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    message;
    /** @type {string} */
    stackTrace;
    /** @type {ArrayOfResponseError} */
    errors;
    /** @type {{ [index: string]: string; }} */
    meta;
}
export class BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ResponseStatus}
     * @description The status of the response */
    responseStatus;
}
export class ActivateValidIdData extends BaseResponse {
    /** @param {{validIdActivated?:boolean,agreementText?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    validIdActivated;
    /** @type {string} */
    agreementText;
}
export class ActivateValidIdResponse {
    /** @param {{data?:ActivateValidIdData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ActivateValidIdData} */
    data;
}
export class ActivateValidIdRequest {
    /** @param {{companyName?:string,companyAddress?:string,companyNumber?:string,name?:string,position?:string,signature?:string,dpaNumber?:string,amlBodyNumber?:string,purpose?:string,classificationId?:number,agreeToTerms?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    companyName;
    /** @type {string} */
    companyAddress;
    /** @type {string} */
    companyNumber;
    /** @type {string} */
    name;
    /** @type {string} */
    position;
    /** @type {string} */
    signature;
    /** @type {string} */
    dpaNumber;
    /** @type {string} */
    amlBodyNumber;
    /** @type {string} */
    purpose;
    /** @type {number} */
    classificationId;
    /** @type {boolean} */
    agreeToTerms;
}
export class ActivateValidId extends BaseRequest {
    /** @param {{request?:ActivateValidIdRequest,authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ActivateValidIdRequest} */
    request;
}

JavaScript ActivateValidId DTOs

POST /soap11 HTTP/1.1 
Host: api.sanctionssearch.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: ActivateValidId

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

<ActivateValidId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <AMLBodyNumber>String</AMLBodyNumber>
    <AgreeToTerms>false</AgreeToTerms>
    <ClassificationId>0</ClassificationId>
    <CompanyAddress>String</CompanyAddress>
    <CompanyName>String</CompanyName>
    <CompanyNumber>String</CompanyNumber>
    <DPANumber>String</DPANumber>
    <Name>String</Name>
    <Position>String</Position>
    <Purpose>String</Purpose>
    <Signature>String</Signature>
  </Request>
</ActivateValidId>

</soap:Body>
</soap:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

<ActivateValidIdResponse 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>
    <AgreementText>String</AgreementText>
    <ValidIdActivated>false</ValidIdActivated>
  </Data>
</ActivateValidIdResponse>

</soap:Body>
</soap:Envelope>