# DPS Card and Account Services

## Search API Reference

- [Getting Started](https://developer.visa.com/capabilities/dps-card-and-account-services/docs-getting-started)
- [Authentication Method](https://developer.visa.com/capabilities/dps-card-and-account-services/docs-authentication)
- [How to Use DPS Card and Account Services](https://developer.visa.com/capabilities/dps-card-and-account-services/docs-how-to)
- [Outbound APIs](https://developer.visa.com/capabilities/dps-card-and-account-services/outbound-apis)
- [How to Generate CVV2](https://developer.visa.com/capabilities/dps-card-and-account-services/docs-how-to-cvv2)
- [Error Codes](https://developer.visa.com/pages/visa-developer-error-codes)
- [API Rate Limits](https://developer.visa.com/capabilities/dps-card-and-account-services/api-rate-limit-policy)
- [Versioning](https://developer.visa.com/capabilities/dps-card-and-account-services/versioning)
- [Product Terms](https://developer.visa.com/capabilities/dps-card-and-account-services/product-terms)
- [Request & Response Codes](https://developer.visa.com/request_response_codes)

### API Reference
  - **Card Activation**
    - postActivate Card with Verification
    - postDigital Activation
    - postActivate Card
  - **Card CVV2**
    - postGenerate Cvv2
  - **Card Inquiry**
    - postSearch Card
    - postInquire Card
  - **Card PIN Management**
    - putChange PIN
    - postSet PIN
    - getRetrieve PIN Settings
  - **Card Services**
    - postCreate Card ID for a PAN V2
    - getRetrieve Card Status - Debit
    - putUpdate Card Status
    - postActivate Card with Verification
    - getRetrieve Card Details
    - getRetrieve Transaction History - DEPRECATED
    - getRetrieve Card Status - Prepaid
  - **Card Transactions**
    - getRetrieve Transaction History - Debit
  - **Cardholder Verification**
    - postCardholder Verification
  - **Program Services**
    - getRetrieve Wire Confirmation Report

[Download DPS Card and Account Services API Reference](blob:https://developer.visa.com/c9d5d301-c798-4b49-802a-4819a3361303)

# Card Activation

Service(s) designed to support functions related to card activation.

## Activate Card with Verification v3 - Latest

This service activates a card for a given Card ID, which is associated to a unique Primary Account Number (PAN). The service is only available for DPS Debit card programs, and supports cardholder token verification as part of the card activation request. By default, at least one token is required in the request. If multiple tokens are provided, all tokens must pass validation prior to activation. If any token fails, activation will not be successful and a generic token failure message will be provided in the response.

For card replacements, a new Card ID must be requested for the new PAN.

This API was designed with considerations for self-service channels such as Voice Response Unit (VRU) automation, combining the token pass/ fail logic in addition to the basic function of activating a card. Other user interfaces such as websites, mobile applications, or enterprise administrative systems would also be able to take advantage of this service.

### Request

#### path Parameters

|     |     |
| --- | --- |
| cardId<br>required | string^[a-zA-Z0-9-]{1,40}+$<br>Unique ID for current card. minLength: 1, maxLength: 40. |

#### header Parameters

|     |     |
| --- | --- |
| X-Correlation-Id | string<br>Id that uniquely identifies a request across distributed systems. Generally populated by the upstream system in this case, VDP or the client. |

#### Request Body schema: application/json

|     |     |
| --- | --- |
| birthDateMmDdYyyy | string<br>${birthDateMmDdYyyy} |
| cardsInfo | object<br>${cardsInfo} |
| |     |     |
| --- | --- |
| cvv2<br>required | string 3 characters <br>${cvv2} |
| expirationDate<br>required | object<br>${expirationDateDescriptionForPinApi} |
| |     |     |
| --- | --- |
| mm<br>required | string<br>${expirationDate.mm}<br>Example: "01 for January and 12 for December." |
| yy<br>required | string<br>${expirationDate.yy}<br>Example: "20 implies 2020" | | |
| driversLicenseInfo | object<br>${driversLicenseInfo} |
| |     |     |
| --- | --- |
| countryCode<br>required | string 3 characters <br>${countryCode} |
| driversLicenseNumber<br>required | string^[^-]+$<br>${driversLicenseNumber} |
| stateCode<br>required | string 2 characters <br>${stateCode} | |
| mothersMaidenName | string<br>${mothersMaidenName} |
| phoneNumber | string^[0-9]{1,20}$<br>${phoneNumber} |
| socialSecurityNumberInfo | object<br>${socialSecurityNumberInfo} |
| |     |     |
| --- | --- |
| last4socialSecurityNumber | string 4 characters <br>${socialSecurityNumberInfo.last4socialSecurityNumber} |
| socialSecurityNumber | string 9 characters <br>${socialSecurityNumberInfo.socialSecurityNumber} |

### Responses

**200 OK**

#### Response Schema: application/json

|     |     |
| --- | --- |
| processingTimeinMs<br>required | integer <int64> <br>${processingTimeInMs} |
| receivedTimestamp<br>required | string<br>${receivedTimeStampExternal} |
| error | object |
| |     |     |
| --- | --- |
| code | integer <int32> <br>HTTP status code |
| description | string<br>HTTP response code description |
| details | Array of objects |
| Array

|     |     |
| --- | --- |
| attribute | string<br>Actual attribute name from the request which caused validation failure. |
| id | string |
| message | string<br>Detail error message. |
| type | string<br>Error Category | | |
| links | Array of objects |
| Array

|     |     |
| --- | --- |
| href | string |
| rel | string |
| type | string | |
| resource | object<br>${resource} |

### Copy

#### Request samples

- Payload

```json
{
  "birthDateMmDdYyyy": "01011960",
  "phoneNumber": "3033891234",
  "socialSecurityNumberInfo": {
    "socialSecurityNumber": "123456789",
    "last4socialSecurityNumber": "6789"
  },
  "driversLicenseInfo": {
    "driversLicenseNumber": "999954317",
    "countryCode": "USA",
    "stateCode": "CO"
  },
  "cardsInfo": {
    "cvv2": "938",
    "expirationDate": {
      "mm": "12",
      "yy": "20"
    }
  },
  "mothersMaidenName": "MOM"
}
```

#### Response samples

- 200

```json
{
  "receivedTimestamp": "2020-10-27T05:11:25.362Z",
  "resource": {
    "isCardActivationSuccessful": true
  },
  "processingTimeinMs": 8295
}
```