DPS Card and Account Services API Reference

DPS Card and Account Services

Search API Reference

API Reference

Download DPS Card and Account Services API Reference

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

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

Responses

200 OK

Response Schema: application/json
processingTimeinMs
required		 integer
${processingTimeInMs}
receivedTimestamp
required		 string
${receivedTimeStampExternal}
error object
--- ---
code integer
HTTP status code
description string
HTTP response code description
details Array of objects
Array
attribute string
Actual attribute name from the request which caused validation failure.
id string
message string
Detail error message.
type string
Error Category
links Array of objects
Array
href string
rel string
type string
resource object
${resource}

Copy

Request samples

{
  "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

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