CDD Engine Web Service v2.14.0.0

<back to all web services

AuthPlusRealtimeCheckDataRequest

Requires Authentication
The following routes are available for this service:
POST/authplus/realtime
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressData:
    address1: Optional[str] = None
    address2: Optional[str] = None
    address3: Optional[str] = None
    postal_code: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactNameData:
    title: Optional[str] = None
    first_name: Optional[str] = None
    middle_name: Optional[str] = None
    last_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IdentityVerificationDocuments:
    document_id: Optional[str] = None
    authenticity: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerDetails:
    day_of_birth: Optional[int] = None
    month_of_birth: Optional[int] = None
    year_of_birth: Optional[int] = None
    ownership_percentage: Optional[float] = None
    home_address: Optional[AddressData] = None
    current_address_less_than_three_years: Optional[bool] = None
    previous_home_address: Optional[AddressData] = None
    name: Optional[ContactNameData] = None
    director: Optional[bool] = None
    nationality: Optional[str] = None
    position: Optional[str] = None
    time_at_home_address_years: Optional[int] = None
    time_at_home_address_months: Optional[int] = None
    primary_party_i_d: Optional[str] = None
    identity_verification_documents: Optional[List[IdentityVerificationDocuments]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuthPlusRealtimeCheckDataRequest:
    application_g_u_i_d: Optional[str] = None
    csr: Optional[int] = None
    owners: Optional[List[OwnerDetails]] = None

Python AuthPlusRealtimeCheckDataRequest 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/realtime HTTP/1.1 
Host: wpcdd-featuretest-ws.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
				}
			]
		}
	]
}