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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApplicationGUID: String,
	CSR: 0,
	Owners: 
	[
		{
			dayOfBirth: 0,
			monthOfBirth: 0,
			yearOfBirth: 0,
			ownershipPercentage: 0,
			homeAddress: 
			{
				address1: String,
				address2: String,
				address3: String,
				postalCode: String,
				city: String,
				state: String,
				countryCode: String
			},
			currentAddressLessThanThreeYears: False,
			previousHomeAddress: 
			{
				address1: String,
				address2: String,
				address3: String,
				postalCode: String,
				city: String,
				state: String,
				countryCode: String
			},
			name: 
			{
				title: String,
				firstName: String,
				middleName: String,
				lastName: String
			},
			director: False,
			nationality: String,
			position: String,
			timeAtHomeAddressYears: 0,
			timeAtHomeAddressMonths: 0,
			PrimaryPartyID: String,
			identityVerificationDocuments: 
			[
				{
					documentId: String,
					authenticity: String
				}
			]
		}
	]
}