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
AuthPlusRealtimeCheckDataRequest Parameters:
NameParameterData TypeRequiredDescription
ApplicationGUIDbodystringYes
CSRbodyintNo
OwnersbodyList<OwnerDetails>Yes
OwnerDetails Parameters:
NameParameterData TypeRequiredDescription
dayOfBirthformintNo
monthOfBirthformintNo
yearOfBirthformintNo
ownershipPercentageformdouble?No
homeAddressformAddressDataNo
currentAddressLessThanThreeYearsformboolNo
previousHomeAddressformAddressDataNo
nameformContactNameDataNo
directorformboolNo
nationalityformstringNo
positionformstringNo
timeAtHomeAddressYearsformint?No
timeAtHomeAddressMonthsformint?No
PrimaryPartyIDformstringNo
identityVerificationDocumentsformList<IdentityVerificationDocuments>No
AddressData Parameters:
NameParameterData TypeRequiredDescription
address1formstringNo
address2formstringNo
address3formstringNo
postalCodeformstringNo
cityformstringNo
stateformstringNo
countryCodeformstringNo
ContactNameData Parameters:
NameParameterData TypeRequiredDescription
titleformstringNo
firstNameformstringNo
middleNameformstringNo
lastNameformstringNo
IdentityVerificationDocuments Parameters:
NameParameterData TypeRequiredDescription
documentIdformstringNo
authenticityformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: wp-cddws-test.worldpay.com 
Accept: text/csv
Content-Type: text/csv
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"}]}]}