CDD Engine Web Service v2.14.0.0

<back to all web services

AuthPlusCheckDataRequest

Requires Authentication
The following routes are available for this service:
POST/authplus/submit

export class AddressData
{
    public address1?: string;
    public address2?: string;
    public address3?: string;
    public postalCode?: string;
    public city?: string;
    public state?: string;
    public countryCode?: string;

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

export class ContactNameData
{
    public title?: string;
    public firstName?: string;
    public middleName?: string;
    public lastName?: string;

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

export class IdentityVerificationDocuments
{
    public documentId?: string;
    public authenticity?: string;

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

export class OwnerDetails
{
    public dayOfBirth?: number;
    public monthOfBirth?: number;
    public yearOfBirth?: number;
    public ownershipPercentage?: number;
    public homeAddress?: AddressData;
    public currentAddressLessThanThreeYears?: boolean;
    public previousHomeAddress?: AddressData;
    public name?: ContactNameData;
    public director?: boolean;
    public nationality?: string;
    public position?: string;
    public timeAtHomeAddressYears?: number;
    public timeAtHomeAddressMonths?: number;
    public PrimaryPartyID?: string;
    public identityVerificationDocuments?: IdentityVerificationDocuments[];

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

export class AuthPlusCheckDataRequest
{
    public ApplicationGUID?: string;
    public CSR?: number;
    public Owners: OwnerDetails[];

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

TypeScript AuthPlusCheckDataRequest DTOs

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.

POST /authplus/submit HTTP/1.1 
Host: wp-cddws-test.worldpay.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AuthPlusCheckDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.dto.Requests">
  <ApplicationGUID>String</ApplicationGUID>
  <CSR>0</CSR>
  <Owners xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
    <d2p1:OwnerDetails>
      <d2p1:PrimaryPartyID>String</d2p1:PrimaryPartyID>
      <d2p1:currentAddressLessThanThreeYears>false</d2p1:currentAddressLessThanThreeYears>
      <d2p1:dayOfBirth>0</d2p1:dayOfBirth>
      <d2p1:director>false</d2p1:director>
      <d2p1:homeAddress>
        <d2p1:address1>String</d2p1:address1>
        <d2p1:address2>String</d2p1:address2>
        <d2p1:address3>String</d2p1:address3>
        <d2p1:city>String</d2p1:city>
        <d2p1:countryCode>String</d2p1:countryCode>
        <d2p1:postalCode>String</d2p1:postalCode>
        <d2p1:state>String</d2p1:state>
      </d2p1:homeAddress>
      <d2p1:identityVerificationDocuments>
        <d2p1:IdentityVerificationDocuments>
          <d2p1:authenticity>String</d2p1:authenticity>
          <d2p1:documentId>String</d2p1:documentId>
        </d2p1:IdentityVerificationDocuments>
      </d2p1:identityVerificationDocuments>
      <d2p1:monthOfBirth>0</d2p1:monthOfBirth>
      <d2p1:name>
        <d2p1:firstName>String</d2p1:firstName>
        <d2p1:lastName>String</d2p1:lastName>
        <d2p1:middleName>String</d2p1:middleName>
        <d2p1:title>String</d2p1:title>
      </d2p1:name>
      <d2p1:nationality>String</d2p1:nationality>
      <d2p1:ownershipPercentage>0</d2p1:ownershipPercentage>
      <d2p1:position>String</d2p1:position>
      <d2p1:previousHomeAddress>
        <d2p1:address1>String</d2p1:address1>
        <d2p1:address2>String</d2p1:address2>
        <d2p1:address3>String</d2p1:address3>
        <d2p1:city>String</d2p1:city>
        <d2p1:countryCode>String</d2p1:countryCode>
        <d2p1:postalCode>String</d2p1:postalCode>
        <d2p1:state>String</d2p1:state>
      </d2p1:previousHomeAddress>
      <d2p1:timeAtHomeAddressMonths>0</d2p1:timeAtHomeAddressMonths>
      <d2p1:timeAtHomeAddressYears>0</d2p1:timeAtHomeAddressYears>
      <d2p1:yearOfBirth>0</d2p1:yearOfBirth>
    </d2p1:OwnerDetails>
  </Owners>
</AuthPlusCheckDataRequest>