Sanctions Search API: v2

ActivateValidId

ValidID

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


// @DataContract
export class Authentication
{
    /** @description The API User ID provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserId: string;

    /** @description The API User Key provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserKey: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseRequest implements IBaseRequest
{
    /** @description The authentication credentials */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public authentication: Authentication;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public fieldName: string;

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

export class ArrayOfResponseError extends Array<ResponseError>
{

    public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ArrayOfResponseError;

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
    /** @description The status of the response */
    // @ApiMember(Description="The status of the response")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class ActivateValidIdData extends BaseResponse
{
    public validIdActivated: boolean;
    public agreementText: string;

    public constructor(init?: Partial<ActivateValidIdData>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class ActivateValidIdResponse
{
    // @DataMember
    public data: ActivateValidIdData;

    public constructor(init?: Partial<ActivateValidIdResponse>) { (Object as any).assign(this, init); }
}

export class ActivateValidIdRequest
{
    public companyName: string;
    public companyAddress: string;
    public companyNumber: string;
    public name: string;
    public position: string;
    public signature: string;
    public dpaNumber: string;
    public amlBodyNumber: string;
    public purpose: string;
    public classificationId: number;
    public agreeToTerms: boolean;

    public constructor(init?: Partial<ActivateValidIdRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ActivateValidId extends BaseRequest
{
    // @DataMember
    public request: ActivateValidIdRequest;

    public constructor(init?: Partial<ActivateValidId>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ActivateValidId DTOs

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"}}}}