The Verifications API from Worldpay — 3 operation(s) for verifications.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/worldpay-verifications-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: 3DS 3DS actions Verifications API
description: "Protect your business and meet regulatory requirements by verifying your customer's identity.\n\n__Authentication header__\n ```\n Authorization: {your_credentials}\n ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager.\n<br /> <br />\n\nYou **must** use the `Authorization` header for any request you send to our 3DS API.\n\n__Accept/Content-Type header__\n ```\n Content-Type: application/vnd.worldpay.verifications.customers-v3.hal+json\n Accept: application/vnd.worldpay.verifications.customers-v3.hal+json\n ```\nWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our 3DS API.\n\nWe require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`.\n<br /><br />\n\n\n__DNS whitelisting__ \nWhitelist the following URLs:\n* `https://try.access.worldpay.com/`\n* `https://access.worldpay.com/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting."
version: '3'
x-metadata:
category:
- 3DS
- SCA Exemptions
business:
- Enterprise
catalog-list: true
generated: false
servers:
- url: https://try.access.worldpay.com
description: Test (Try)
- url: https://access.worldpay.com
description: Live
security:
- BasicAuth: []
tags:
- name: Verifications
paths:
/verifications/customers/3ds/deviceDataInitialization:
post:
summary: Generate required data for 3DS Device Data Collection
description: 'Allow card issuers to perform Device Data Collection to fingerprint your customer''s device.
'
operationId: deviceDataInitialize
parameters:
- in: header
name: Content-Type
required: true
schema:
type: string
example: application/vnd.worldpay.verifications.customers-v3.hal+json
- in: header
name: Accept
required: true
schema:
type: string
example: application/vnd.worldpay.verifications.customers-v3.hal+json
requestBody:
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_deviceDataInitialize'
examples:
card/front:
$ref: '#/components/examples/ddc-card'
card/tokenized:
$ref: '#/components/examples/ddc-token'
card/networkToken:
$ref: '#/components/examples/ddc-networktoken'
card/wallet+googlepay:
$ref: '#/components/examples/ddc-googlepay'
No payment instrument provided (only jwt returned):
$ref: '#/components/examples/ddc-request'
responses:
'200':
description: The data for the device data collection has been generated
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_deviceDataInitialize_200_response'
examples:
card/front:
$ref: '#/components/examples/ddc-jwt-bin'
card/tokenized:
$ref: '#/components/examples/ddc-jwt-bin'
card/networkToken:
$ref: '#/components/examples/ddc-jwt-bin'
Wallet token already authenticated:
$ref: '#/components/examples/already-authenticated'
No payment instrument provided (only jwt returned):
$ref: '#/components/examples/ddc-jwt-only'
'400':
description: The request has encountered validation errors
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_deviceDataInitialize_400_response'
examples:
The request is missing a mandatory field `transactionReference`:
description: The request does not have a mandatory field `transactionReference`
value:
message: The json body provided does not match the expected schema
errorName: bodyDoesNotMatchSchema
validationErrors:
- errorName: stringIsTooShort
jsonPath: $.transactionReference
message: Transaction reference must be between 1 and 64 characters inclusive
_links:
3ds:deviceDataInitialize:
href: $serverUrl/verifications/customers/3ds/deviceDataInitialization
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
templated: true
name: 3ds
The request contains an invalid `Content-Type` header:
description: The request contains an invalid `Content-Type` header
value:
message: Provided request contains a header with an invalid value
errorName: headerHasInvalidValue
headerName: Content-Type
_links:
3ds:deviceDataInitialize:
href: $serverUrl/verifications/customers/3ds/deviceDataInitialization
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
name: 3ds
templated: true
'502':
description: Invalid response received from upstream
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_deviceDataInitialize_502_response'
examples:
An invalid response is received from upstream:
description: An invalid response is received from upstream
value:
path: /verifications/customers/3ds/deviceDataInitialization
status: 502
message: Service Unavailable
errorName: serviceUnavailable
_links:
3ds:deviceDataInitialize:
href: $serverUrl/verifications/customers/3ds/deviceDataInitialization
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
name: 3ds
templated: true
'503':
description: The requested service is unavailable
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_deviceDataInitialize_503_response'
examples:
The requested service is unavailable:
description: The requested service is unavailable
value:
message: Service Unavailable
errorName: serviceUnavailable
_links:
3ds:deviceDataInitialize:
href: $serverUrl/verifications/customers/3ds/deviceDataInitialization
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
name: 3ds
templated: true
tags:
- Verifications
/verifications/customers/3ds/authentication:
post:
summary: Initiate the 3DS authentication
description: 'Authenticate your customer by submitting order and risk data.
'
operationId: authenticate
parameters:
- in: header
name: Content-Type
schema:
type: string
example: application/vnd.worldpay.verifications.customers-v3.hal+json
- in: header
name: Accept
schema:
type: string
example: application/vnd.worldpay.verifications.customers-v3.hal+json
requestBody:
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_authenticate'
examples:
card/front:
$ref: '#/components/examples/authentication-card'
card/tokenized:
$ref: '#/components/examples/authentication-token'
card/networkToken:
$ref: '#/components/examples/authentication-networktoken'
card/wallet+googlepay:
$ref: '#/components/examples/authentication-googlepay'
Minimum Recommended (web):
$ref: '#/components/examples/authentication-card-recommended-web'
Minimum Recommended (native):
$ref: '#/components/examples/authentication-card-recommended-native'
responses:
'200':
description: The authentication has been created
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
anyOf:
- $ref: '#/components/schemas/3DS_authenticate_200_response'
- $ref: '#/components/schemas/3DS_authenticate_200_response_cartes_bancaires'
- $ref: '#/components/schemas/3DS_authenticate_challenged_200_response'
- $ref: '#/components/schemas/3DS_authenticate_200_response_authentication_failed'
- $ref: '#/components/schemas/3DS_authenticate_200_response_unavailable'
- $ref: '#/components/schemas/3DS_authenticate_200_response_bypassed'
- $ref: '#/components/schemas/3DS_authenticate_200_response_authentication_outage'
examples:
authenticated:
$ref: '#/components/examples/authentication-authenticated'
authenticated (Cartes Bancaires):
$ref: '#/components/examples/authentication-authenticated-cartesbancaires'
alreadyAuthenticated:
$ref: '#/components/examples/already-authenticated'
challenged:
$ref: '#/components/examples/authentication-challenged'
authenticationFailed:
$ref: '#/components/examples/authentication-authentication-failed'
unavailable:
$ref: '#/components/examples/authentication-unavailable'
authenticationOutage:
$ref: '#/components/examples/authentication-authentication-outage'
bypassed:
$ref: '#/components/examples/authentication-bypassed'
'400':
description: The request has encountered validation errors
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_authenticate_400_response'
examples:
The request is missing a mandatory field `merchant`:
description: The request does not have a mandatory field `merchant`
value:
message: The json body provided does not match the expected schema
errorName: bodyDoesNotMatchSchema
validationErrors:
- errorName: fieldIsMissing
jsonPath: $.merchant
message: Merchant must be provided
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
templated: true
name: 3ds
The request contains an invalid `Content-Type` header:
description: The request contains an invalid `Content-Type` header
value:
message: Provided request contains a header with an invalid value
errorName: headerHasInvalidValue
headerName: Content-Type
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
name: 3ds
templated: true
The request is using an invalid HTTP method:
description: The request is using an invalid HTTP method
value:
errorName: methodNotAllowed
allowedMethods:
- POST
message: Method GET not allowed for this request
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
name: 3ds
templated: true
'502':
description: Invalid response received from upstream
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_authenticate_502_response'
examples:
An invalid response is received from upstream:
description: An invalid response is received from upstream
value:
path: /verifications/customers/3ds/authentication
status: 502
message: Service Unavailable
errorName: serviceUnavailable
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
templated: true
name: 3ds
'503':
description: The requested service is unavailable
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_authenticate_503_response'
examples:
The requested service is unavailable:
description: The requested service is unavailable
value:
path: /verifications/customers/3ds/authentication
status: 503
message: Service Unavailable
errorName: serviceUnavailable
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
templated: true
name: 3ds
tags:
- Verifications
/verifications/customers/3ds/verification:
post:
summary: Verify the 3DS challenge response
description: 'Verify the results of a challenged authentication.
'
operationId: verify
parameters:
- in: header
name: Content-Type
schema:
type: string
example: application/vnd.worldpay.verifications.customers-v3.hal+json
- in: header
name: Accept
schema:
type: string
example: application/vnd.worldpay.verifications.customers-v3.hal+json
requestBody:
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_verify'
examples:
Verification:
$ref: '#/components/examples/verification-request'
responses:
'200':
description: The challenge was successful - obtain the authentication data for onward use
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
anyOf:
- $ref: '#/components/schemas/3DS_verify_200_response'
- $ref: '#/components/schemas/3DS_verify_200_response_failed'
- $ref: '#/components/schemas/3DS_verify_200_response_unavailable'
- $ref: '#/components/schemas/3DS_verify_200_response_signature_failed'
examples:
authenticated:
$ref: '#/components/examples/verification-authenticated'
authenticationFailed:
$ref: '#/components/examples/verification-authentication-failed'
unavailable:
$ref: '#/components/examples/verification-unavailable'
signatureFailed:
$ref: '#/components/examples/verification-signature-failed'
'400':
description: The request has encountered validation errors
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_verify_400_response'
examples:
The request contains invalid characters:
description: The request contains invalid characters in `transactionReference` and `merchant.entity` fields
value:
path: /verifications/customers/3ds/verification
status: 400
message: The json body provided does not match the expected schema
errorName: bodyDoesNotMatchSchema
validationErrors:
- errorName: stringFailedRegexCheck
jsonPath: $.merchant.entity
message: Entity must be alphanumeric with optional spaces
- errorName: stringFailedRegexCheck
jsonPath: $.transactionReference
message: 'Transaction reference characters must be alphanumeric or one of the following: _!@#$%()*=-.:;?[]{}~`/+'
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
templated: true
name: 3ds
The request contains an invalid `Content-Type` header:
description: The request contains an invalid `Content-Type` header
value:
path: /verifications/customers/3ds/verification
status: 400
message: Provided request contains a header with an invalid value
errorName: headerHasInvalidValue
headerName: Content-Type
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
name: 3ds
templated: true
The request is using an invalid HTTP method:
description: The request is using an invalid HTTP method
value:
message: Method GET not allowed for this request
errorName: methodNotAllowed
allowedMethods:
- POST
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
templated: true
name: 3ds
'502':
description: Invalid response received from upstream
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_authenticate_502_response'
examples:
An invalid response is received from upstream:
description: An invalid response is received from upstream
value:
path: /verifications/customers/3ds/authentication
status: 502
message: Service Unavailable
errorName: serviceUnavailable
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
templated: true
name: 3ds
'503':
description: The requested service is unavailable
content:
application/vnd.worldpay.verifications.customers-v3.hal+json:
schema:
$ref: '#/components/schemas/3DS_authenticate_503_response'
examples:
The requested service is unavailable:
description: The requested service is unavailable
value:
path: /verifications/customers/3ds/authentication
status: 503
message: Service Unavailable
errorName: serviceUnavailable
_links:
3ds:authenticate:
href: $serverUrl/verifications/customers/3ds/authentication
3ds:verify:
href: $serverUrl/verifications/customers/3ds/verification
curies:
- href: $serverUrl/rels/verifications/customers/3ds/{rel}
templated: true
name: 3ds
tags:
- Verifications
components:
schemas:
merchant:
required:
- entity
type: object
description: An object that contains information about the merchant and API level configuration.
properties:
entity:
maxLength: 64
minLength: 1
pattern: ^[A-Za-z0-9 ]*$
type: string
description: Used to route the request in Access Worldpay, created as part of on-boarding.
authenticationValue:
maxLength: 64
minLength: 1
type: string
description: "A cryptographic value that provides evidence of the outcome of a 3DS verification. \n- Visa - Cardholder Authentication Verification Value (CAVV)\n- Mastercard - Universal Cardholder Authentication Field (UCAF)\n"
3DS_verify_400_response:
required:
- message
- errorName
type: object
properties:
path:
type: string
maxLength: 2048
minLength: 1
description: The request URI path
status:
maxLength: 3
minLength: 3
type: integer
description: The HTTP status returned from server
message:
type: string
maxLength: 2048
minLength: 1
description: The error description message
errorName:
type: string
maxLength: 2048
minLength: 1
description: The unique error name
headerName:
type: string
maxLength: 2048
minLength: 1
description: The name of the header containing invalid value
allowedMethods:
type: array
description: List of HTTP methods that are allowed
items:
type: string
validationErrors:
description: Object containing details of validation errors occurred
type: array
items:
$ref: '#/components/schemas/validation_errors'
_links:
$ref: '#/components/schemas/links'
challengeResponse:
type: object
description: Object containing challenge related information in case of a "challenged" flow
properties:
reference:
maxLength: 20
minLength: 1
type: string
description: This links the authentication response to the subsequent challenge form and verification request.
url:
maxLength: 2048
minLength: 1
type: string
description: POST action on the challenge form. Used to redirect to the issuers challenge page as part of the challenge form.
jwt:
maxLength: 2048
minLength: 1
type: string
description: A digitally signed token that contains additional details, such as the URL to return to after the challenge screen. Expires in `10` minutes on Try and `30 sec` on Live
payload:
maxLength: 2048
minLength: 1
type: string
description: JSON container with extra data required for the challenge. This is used by the native SDK (iOS/Android) only.
3DS_deviceDataInitialize_503_response:
required:
- message
- errorName
type: object
properties:
path:
type: string
maxLength: 2048
minLength: 1
description: The request URI path
status:
maxLength: 3
minLength: 3
type: integer
description: The HTTP status returned from server
message:
type: string
maxLength: 2048
minLength: 1
description: The error description message
errorName:
type: string
maxLength: 2048
minLength: 1
description: The unique error name
_links:
$ref: '#/components/schemas/links'
3DS_deviceDataInitialize_400_response:
required:
- message
- errorName
type: object
properties:
path:
type: string
maxLength: 2048
minLength: 1
description: The request URI path
status:
maxLength: 3
minLength: 3
type: integer
description: The HTTP status returned from server
message:
type: string
maxLength: 2048
minLength: 1
description: The error description message
errorName:
type: string
maxLength: 2048
minLength: 1
description: The unique error name
headerName:
type: string
maxLength: 2048
minLength: 1
description: The name of the header containing invalid value
allowedMethods:
type: array
description: List of HTTP methods that are allowed
items:
type: string
validationErrors:
description: Object containing details of validation errors occurred
type: array
items:
$ref: '#/components/schemas/validation_errors'
_links:
$ref: '#/components/schemas/links'
eci:
maxLength: 2
minLength: 1
type: string
description: "Electronic Commerce Indicator (ECI). Indicates the outcome of the 3DS authentication. \n\n| ECI | Meaning | \n|---|---| \n| 02 or 05 | Fully Authenticated Transaction | \n| 01 or 06 | Attempted Authentication Transaction | \n| 00 or 07 | Non 3-D Secure Transaction | \n\n| Scheme | Value | \n|---|---| \n| Mastercard | 02, 01, 00 |\n| Visa | 05, 06, 07 |\n| Amex | 05, 06, 07 | \n| JCB | 05, 06, 07 |\n| Diners | 05, 06, 07 |"
links:
title: Links
type: object
additionalProperties: true
authentication:
type: object
description: Object that contains authentication related information.
properties:
version:
$ref: '#/components/schemas/version'
eci:
$ref: '#/components/schemas/eci'
authenticationValue:
$ref: '#/components/schemas/authenticationValue'
transactionId:
$ref: '#/components/schemas/transactionId'
3DS_authenticate_200_response:
title: authenticated
required:
- outcome
type: object
properties:
outcome:
enum:
- alreadyAuthenticated
- authenticated
- authenticationFailed
- authenticationOutage
- bypassed
- challenged
- notEnrolled
- signatureFailed
- unavailable
type: string
description: The outcome of the authentication request.
transactionReference:
maxLength: 64
minLength: 1
type: string
description: A unique reference for authentication that was passed in the request.
acsTransactionId:
$ref: '#/components/schemas/acsTransactionId'
status:
$ref: '#/components/schemas/status'
enrolled:
$ref: '#/components/schemas/enrolled'
authentication:
$ref: '#/components/schemas/authentication'
_links:
$ref: '#/components/schemas/links'
3DS_authenticate:
required:
- transactionReference
- merchant
- instruction
- deviceData
- challenge
type: object
properties:
transactionReference:
$ref: '#/components/schemas/transactionReference'
merchant:
required:
- entity
type: object
description: An object that contains information about the merchant and API level configuration.
properties:
entity:
maxLength: 64
minLength: 1
pattern: ^[A-Za-z0-9 ]*$
type: string
description: Used to route the request in Access Worldpay, created as part of on-boarding.
overrideName:
type: string
maxLength: 25
minLength: 1
pattern: ^[^><&'\"]*
description: Used to override the merchant name that's both submitted to issuers as well as displayed to the customer in the authentication process. PayFac merchants should submit the name of their submerchant.
acquirerId:
type: string
maxLength: 20
minLength: 1
example: '01234567'
pattern: ^[0-9]*$
description: Instructs the issuer that the following authorization will be completed with an external acquirer
instruction:
required:
- value
- paymentInstrument
type: object
description: The object that contains all the payment information related to the authentication request.
properties:
value:
required:
- amount
- currency
type: object
description: An object that contains information about the value of the authentication.
properties:
amount:
maximum: 99999999999
minimum: 0
type: integer
description: The authentica
# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/worldpay/refs/heads/main/openapi/worldpay-verifications-api-openapi.yml