Important: We have released a new version. Documentation for our latest version can be foundhere.

Get started with our Verifications API

API v2

Note: This documentation covers version 2 of our Verifications API. Documentation for our latest version can be foundhere.

Query the root resource

Our APIs guide you by providing you with links to the next available actions. To discover and start using our APIs you must first query the root resource.

Discover our API resources by querying the root resource. Querying the root resource returns the available resources within Access Worldpay. Use the resources to send your requests depending on which of our APIs you're integrating into.

GET https://try.access.worldpay.com/

Note: No request body is needed for this request.

Query the root resource response

Copied!

{
    "_links": {
        "payments:authorize": {
            "href": "https://try.access.worldpay.com/payments/authorizations"
        },
        "service:payments": {
            "href": "https://try.access.worldpay.com/payments"
        },
        "service:sessions": {
            "href": "https://try.access.worldpay.com/sessions"
        },
        "service:tokens": {
            "href": "https://try.access.worldpay.com/tokens"
        },
        "service:verifications/accounts": {
            "href": "https://try.access.worldpay.com/verifications/accounts"
        },
        "service:verifications/customers/3ds": {
            "href": "https://try.access.worldpay.com/verifications/customers/3ds"
        },
        "service:verifiedTokens": {
            "href": "https://try.access.worldpay.com/verifiedTokens"
        },
        "service:fraudsight": {
            "href": "https://try.access.worldpay.com/fraudsight"
        },
        "service:exemptions": {
            "href": "https://try.access.worldpay.com/exemptions"
        },
        "service:payouts": {
            "href": "https://try.access.worldpay.com/payouts"
        },
        "service:payment_pages": {
            "href": "https://try.access.worldpay.com/payment_pages"
        },
        "service:payments/alternative/direct": {
            "href": "https://try.access.worldpay.com/payments/alternative/direct"
        },
        "service:payments/alternative/action/paypal": {
            "href": "https://try.access.worldpay.com/payments/alternative/action/paypal"
        },
        "service:payments/alternative/action/ideal": {
            "href": "https://try.access.worldpay.com/payments/alternative/action/ideal"
        },
        "service:moneyTransfers": {
            "href": "https://try.access.worldpay.com/moneyTransfers"
        },
        "curies": [
            {
                "href": "https://try.access.worldpay.com/rels/payments/{rel}",
                "name": "payments",
                "templated": true
            }
        ]
    }
}

In the response are our available API resources. You must then query the resources to discover the specific API resources. The response contains links to your next available actions and the resources to send your request to.

Set your headers

Setting your headers is an important part of an API request. The headers represent the meta-data associated with your API request.

Copied!

Authorization: {your_credentials},
Content-Type : application/vnd.worldpay.verifications.accounts-v2+json,
Accept : application/vnd.worldpay.verifications.accounts-v2+json

Authorization: {your_credentials}, Content-Type : application/vnd.worldpay.verifications.accounts-v2+json, Accept : application/vnd.worldpay.verifications.accounts-v2+json

Header	Description
`Authorization`	The `Authorization` header is used for authentication and identification of our merchants within Access Worldpay. You must use the `Authorization` header for any request you send to our Verifications API.
`Content-Type`	The `Content-Type` header is required if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`.
`Accept`	The `Accept` header is used to identify which version of our Verifications API you are using. You must use the `Accept` header for any request you send to our Verifications API.

The Content-Type and Accept headers, must match.

Note: Replace {your_credentials} with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your Implementation Manager.

Query verifications root resource

Query the verifications root resource to get the resources to our verifications API.

GET https://try.access.worldpay.com/verifications/accounts

The response

Copied!

{
    "_links": {
        "resourceTree": {
            "href": "https://try.access.worldpay.com/rels/verifications/accounts/resourceTree"
        },
        "verifications:oneTime": {
            "href": "https://try.access.worldpay.com/verifications/accounts/intelligent/oneTime",
            "templated": true
        },
        "verifications:cardOnFile": {
            "href": "https://try.access.worldpay.com/verifications/accounts/intelligent/cardOnFile",
            "templated": true
        },
        "verifications:verification": {
            "href": "https://try.access.worldpay.com/verifications/accounts/{resource}",
            "templated": true
        },
        "curies": [{
            "name": "verifications",
            "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
            "templated": true
        }]
    }
}

Resources

Resources	Description
`verifications:oneTime`	Verify a oneTime payment.
`verifications:cardOnFile`	Verify a cardOnFile payment.
`verifications:verification`	Send a request to receive the result of a historic verification.

Next steps

Verify a customer's account

Searching accross the entire site

Filter by product

Filter by product Searching across the entire site

Get started with our Verifications API

Query the root resource

Query the root resource response

Set your headers

Query verifications root resource

The response

Resources

Searching accross the entire site

Filter by product

Filter by product Searching across the entire site

​