Menu

Get started with our Verifications API

API v5
Last updated March 2023
Change log

Make yourself familiar with ourAPI Principlesto ensure a resilient integration.

Enable Verifications

Ask yourRelationship Managerto enable Verifications during boarding.

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-v5+json,
Accept : application/vnd.worldpay.verifications.accounts-v5+json
HeaderDescription
AuthorizationWe use the Authorization header to identify and authenticate you within Access Worldpay. You must use the Authorization header for any request you send to our Verifications API, unless you are using client certificate authentication over TLS. If you must use this, read our reference guide onAuthenticating with SSL/TLS.
Content-TypeWe require the Content-Type header for all requests sent to our Verifications API.
AcceptWe use the Accept header 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 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. This returns the available resources within Access Worldpay.

Request

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

Note: No request body is needed for this request.

Response

You receive all our available API resources in the 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
            }
        ]
    }
}

Query verifications root resource

Query the service:verifications/accounts 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:recurring": {
      "href": "https://try.access.worldpay.com/verifications/accounts/intelligent/recurring",
      "templated": true
    },
    "verifications:dynamicOneTime": {
      "href": "https://try.access.worldpay.com/verifications/accounts/dynamic/oneTime",
      "templated": true
    },
    "verifications:dynamicCardOnFile": {
      "href": "https://try.access.worldpay.com/verifications/accounts/dynamic/cardOnFile",
      "templated": true
    },
    "verifications:dynamicRecurring": {
      "href": "https://try.access.worldpay.com/verifications/accounts/dynamic/recurring",
      "templated": true
    },
    "verifications:verification": {
      "href": "https://try.access.worldpay.com/verifications/accounts/{resource}",
      "templated": true
    },
    "verifications:ach": {
      "href": "https://try.access.worldpay.com/verifications/accounts/ach",
      "templated": true
    },
    "curies": [
      {
        "name": "verifications",
        "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
        "templated": true
      }
    ]
  }
}

Choose one of the action links and send your request to the corresponding resource.

Resources

ResourcesDescription
verifications:oneTimeVerify a oneTime payment.
verifications:cardOnFileVerify a cardOnFile payment.
verifications:recurringDo not use.
verifications:dynamicOneTimeVerify your customer's oneTime payment against a specified amount.
verifications:dynamicCardOnFileVerify your customer's cardOnFile payment against a specified amount.
verifications:dynamicRecurringDo not use.
verifications:verificationSend a request to receive the result of a historic verification.
verifications:achVerify a US bank account payment.

Next steps

Verify a customer's account