# Verify Address

Initiates an Address Verification Service (AVS) check for the provided billing address.This request will validate the address details (e.g., street address, zip code) and return a response indicating whether the address matches the records on file with the payment provider.

Endpoint: POST /paymentmethods/avs
Security: SecuritySchemas.oidcEnforcement

## Security:

  - `SecuritySchemas.oidcEnforcement` (unknown)
    oauth2

## Header parameters:

  - `partnerToken` (string, required)
    Unique Merchant Identifier for API Calls

  - `requestId` (string)
    Unique request identifier in GUID format included in the header, used to trace and correlate API calls across systems.
> **Note:** We strongly recommend including the `requestId` header in every API request. This unique GUID helps trace and correlate API calls across systems, ensuring better observability and troubleshooting.

## Request body:

  - `application/json` (unknown)
    Request details used to get avs.

## Request fields (application/json):

  - `paymentMethod` (any, required)
    Payment method details used to get avs.

  - `paymentMethod.card` (object, required)
    Object to hold card details such as card number, expiration date, and CVV. Includes billing address for verification purposes. Supports secure, PCI-compliant card-based transactions while reducing exposure of sensitive payment data across digital checkout and payment authorization flows.

  - `paymentMethod.card.card` (string, required)
    Card Number
    Example: 4111111111111110

  - `paymentMethod.card.expiry` (string, required)
    Card Expiration Month and Year
    Example: 11/26

  - `paymentMethod.card.cvv` (string)
    Card CVV/Security Code
    Example: 245

  - `paymentMethod.billingAddress` (object)
    Billing Address details includes name, street address, city, postal code, country, and optional contact information like phone and email. These fields support payment verification, fraud prevention, and customer record enrichment, making it easier to integrate with billing, invoicing, compliance systems.

  - `paymentMethod.billingAddress.state` (string)
    Customer's state/province
    Example: CA

  - `paymentMethod.billingAddress.address` (string)
    Customer's address
    Example: 123 Main St

  - `paymentMethod.billingAddress.lastName` (string)
    Customer's last name
    Example: Doe

  - `paymentMethod.billingAddress.firstName` (string)
    Customer's first name
    Example: Jane

  - `paymentMethod.billingAddress.email` (string)
    Customer's email address
    Example: jane@email.com

  - `paymentMethod.billingAddress.country` (string)
    Customer's country
    Example: USA

  - `paymentMethod.billingAddress.phone` (string)
    Customer's phone number
    Example: 650-555-1234

  - `paymentMethod.billingAddress.city` (string)
    Customer's city
    Example: San Francisco

  - `paymentMethod.billingAddress.address2` (string)
    Customer's address line 2
    Example: Apt 5

  - `paymentMethod.billingAddress.postalCode` (string)
    Customer's postal/zip code
    Example: 94111

  - `paymentMethod.token` (object, required)
    Object to hold tokenized card information such as card number, expiration date, and CVV. Includes billing address for validation. Supports secure, PCI-compliant digital transactions with minimal exposure of sensitive data, enabling efficient payment processing across web, mobile, and in-store environments.

  - `paymentMethod.token.token` (string, required)
    Tokenized string for Card details
    Example: 1234567890123450

  - `paymentMethod.token.expiry` (string, required)
    Card Expiration Month and Year
    Example: 10/25

  - `paymentMethod.token.cvv` (string)
    Card CVV/Security Code
    Example: 245

  - `paymentMethod.vault` (object, required)
    Object to hold payment method details such as stored payment ID and optional CVV. It enables secure retrieval of tokenized payment credentials for recurring billing or one-click checkout scenarios. Includes billing address to support verification, fraud prevention, and transaction accuracy while aligning with compliance requirements in digital payment flows.

  - `paymentMethod.vault.paymentMethodId` (string, required)
    Unique identifier for stored payment method
    Example: d290f1ee-6c54-4b01-90e6-c701748f0851

  - `paymentMethod.vault.cvv` (string)
    CVV/Security Code
    Example: 245

  - `paymentMethod.cryptogram` (object, required)
    Object to hold cryptogram data such as tokenized transaction values and billing address. It supports secure transmission of card or bank details using encrypted strings, enabling safe, compliant digital payments across banking and e-commerce environments. Ideal for tokenization workflows requiring enhanced data protection and minimal exposure of sensitive financial information.

  - `paymentMethod.cryptogram.cryptogram` (string, required)
    Tokenized string that passes Card or Bank details for transaction
    Example: 6cd3ef836ce141b789b5755ca3f353f1

  - `paymentMethod.networkToken` (object, required)
    Object to hold secured network token data such as token string, expiration details, cryptographic authentication values, and token source (e.g., ApplePay, GooglePay, Paze). It enhances payment security and enables streamlined digital transactions. Includes billing address and other identifiers to support robust authorization, risk mitigation, and regulatory compliance in tokenized payment ecosystems.

  - `paymentMethod.networkToken.token` (string, required)
    Network token string
    Example: 4895370017589737

  - `paymentMethod.networkToken.expiryMonth` (string, required)
    Expiry month
    Example: 05

  - `paymentMethod.networkToken.expiryYear` (string, required)
    Expiry Year
    Example: 2032

  - `paymentMethod.networkToken.secureCavvData` (string, required)
    Secure cavv data
    Example: AwAAAAAAmCjhPZYp4s7YQHwAAAA=

  - `paymentMethod.networkToken.eci` (string)
    Electronic commerce indicator
    Example: 07

  - `paymentMethod.networkToken.tokenType` (number)
    Token type flag
    Example: 1

  - `paymentMethod.networkToken.tokenSource` (string, required)
    Token Source - ApplePay/GooglePay/Paze
    Enum: "APPLEPAY", "GOOGLEPAY", "PAZE", "VISA"

## Response 200:

  - `200` (unknown)
    Object to hold avs response details.

## Response 200 fields (application/json):

  - `accountResponseData` (object, required)
    Object to hold account response data.

  - `accountResponseData.avs` (string, required)
    Address verification response
    Example: Y

  - `accountResponseData.cvv` (string, required)
    CVV verification response
    Example: Y

  - `authResponse` (string, required)
    Authorization code from issuer
    Example: ABC123

  - `responseCode` (number, required)
    Authorizer response code
    Example: 0

  - `responseMessage` (string, required)
    Description of response code
    Example: Success

  - `requestId` (string, required)
    Unique identifier for an API call
    Example: a2406639-8692-4e1c-978d-1805eb13efdf

  - `paymentId` (string, required)
    Payment gateway transaction ID
    Example: d290f1ee-6c54-4b01-90e6-d701748f0851

## Response 400:

  - `400` (unknown)
    Bad Request

## Response 400 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 404:

  - `404` (unknown)
    Not Found

## Response 404 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 405:

  - `405` (unknown)
    Method Not Allowed

## Response 405 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 406:

  - `406` (unknown)
    Not Acceptable

## Response 406 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 408:

  - `408` (unknown)
    Connection Timeout

## Response 408 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 415:

  - `415` (unknown)
    Unsupported Media Type

## Response 415 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 429:

  - `429` (unknown)
    Too Many Requests

## Response 429 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 500:

  - `500` (unknown)
    Internal Server Error

## Response 500 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 501:

  - `501` (unknown)
    Not Implemented

## Response 501 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 503:

  - `503` (unknown)
    Service Unavailable

## Response 503 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

## Response 504:

  - `504` (unknown)
    Gateway Timeout

## Response 504 fields (application/json):

  - `errors` (object, required)
    error object containing the details of the error.

  - `errors.message` (string, required)
    Example: Bad Request

  - `errors.details` (string)
    Example: There was an issue with your request message.

