# Visa Credit Card Application

## CCA API

### CCA Realtime API  v1 - Latest

This endpoint processes CCA realtime API requests.

## Request

### Request Body schema: application/json

|     |     |
| --- | --- |
| requestType<br>required | string 2 characters <br>16 - Declined application. For Consumer or Small Business Application.<br>17 - Application (Approved/approvable application, application in process). For Consumer or Small Business Application.<br>18 - Unauthorized use (UU)/credit card fraud. For Consumer or Small Business Fraud.<br>28 - Debit card Fraud.<br>58 - Merchant Fraud.<br>68 - Prepaid card Fraud.<br>78 - Other card Fraud.<br>19 - Inquiry.<br>29 - Debit inquiry.<br>49 - Non-bankcard inquiry.<br>59 - Request to delete previously reported record.<br>Example: "17" |
| serviceSubscriberType<br>required | string 1 characters <br>Must be V (Visa).<br>Example: "V" |
| comment | string or null \[ 0 .. 34 \] characters <br>Issuer use comments.<br>Example: "Add App with UU" |
| Consumer-identity | object<br>Group of data elements tied to Consumer Identity. |
| |     |     |
| --- | --- |
| accountNumber | string or null \[ 0 .. 16 \] characters <br>Required for request record type 18, 28, 58, 68, or 78.<br>Value will be 16 digit primary card number.<br>If request is with regard to an existing card account, the account number will be the one associated with the card.<br>Not applicable for Unauthorized use (UU) type codes '07' and '08'.<br>Example: "4500010098110001" |
| Consumer-alternate-address | object<br>Consumer's "Mail to" or "other" address on file at time of application/inquiry. |
| |     |     |
| --- | --- |
| address2City | string or null \[ 0 .. 28 \] characters <br>City Name.<br>Example: "Hanover Park" |
| address2Line1 | string or null \[ 0 .. 35 \] characters <br>Street Number and Street Name. PO BOX can be listed in Address2Line1 or Address2Line2.<br>Example: "1928 Pastoral Ln" |
| address2Line2 | string or null \[ 0 .. 35 \] characters <br>Secondary unit designator. Required for multi-unit dwellings. PO BOX can be listed in Address2Line1 or Address2Line2. |
| address2State | string or null <iso3166-2>  \[ 0 .. 2 \] characters <br>2-letter state code.<br>Example: "IL" |
| address2Zip5 | string or null \[ 0 .. 5 \] characters <br>First 5 digits of zip code.<br>Example: "60188" |
| address2ZipSuffix4 | string or null \[ 0 .. 4 \] characters <br>Only last 4 suffix digits of zip code (items after hyphen).<br>Example: "1111" | |
| Consumer-device-data | object<br>Consumer device data captured by subscriber's service/API. |
| |     |     |
| --- | --- |
| deviceID | string or null \[ 0 .. 40 \] characters <br>The unique device ID generated by the device ID provider.<br>Example: "100.101.100.100" |
| deviceIdProvider | string or null \[ 0 .. 1 \] characters <br>1 - Lovation<br>2 - ThreatMetrix<br>3 - 41st Parameter<br>4 - Kount<br>5 - Others<br>Example: "4" | |
| Consumer-name | object<br>Group of data elements tied to name components (US format). |
| |     |     |
| --- | --- |
| firstName | string or null \[ 0 .. 10 \] characters <br>Applicant's first name.<br>Example: "BEVERLY" |
| lastName | string or null \[ 0 .. 19 \] characters <br>Applicant's last name.<br>Example: "WELLING" |
| middleNameOrInitial | string or null \[ 0 .. 1 \] characters <br>Applicant's middle initial.<br>Example: "J" | |
| Consumer-phone-numbers | object<br>Group of data elements tied to phone numbers. |
| |     |     |
| --- | --- |
| primaryPhone | string or null \[ 0 .. 10 \] characters <br>Applicant's phone number.<br>Example: "7012802796" |
| secondaryPhone | string or null \[ 0 .. 10 \] characters <br>Applicant's second phone number.<br>Example: "3012211234" | |
| Consumer-primary-address | object<br>Consumer's official address on file at time of application/inquiry. |
| |     |     |
| --- | --- |
| address1City | string or null \[ 0 .. 28 \] characters <br>City Name.<br>Example: "WICHITA" |
| address1Line1 | string or null \[ 0 .. 35 \] characters <br>Street Number and Street Name. PO BOX can be listed in address1Line1 or address1Line2.<br>Example: "7620 W DOUGLAS AVE" |
| address1Line2 | string or null \[ 0 .. 27 \] characters <br>Secondary unit designator for multi-unit dwellings. PO BOX can be listed in address1Line1 or address1Line2. |
| address1State | string or null <iso3166-2>  \[ 0 .. 2 \] characters <br>2-letter state code.<br>Example: "KS" |
| address1Zip5 | string or null \[ 0 .. 5 \] characters <br>First 5 digits of zip code.<br>Example: "67212" |
| address1ZipSuffix4 | string or null \[ 0 .. 4 \] characters <br>Only last 4 suffix digits of zip code (items after hyphen).<br>Example: "6132" | |
| Consumer-state-id-other | object<br>Group of data elements tied to Other-ID. |
| |     |     |
| --- | --- |
| idNumber | string or null \[ 0 .. 30 \] characters <br>Can be passport number (both US and others), NEXUS, SENTRI or other forms of ID.<br>Example: "230978657" |
| issuingEntity | string or null \[ 0 .. 2 \] characters <br>Country code or other issuing entity for ID Number.<br>Example: "IL" | |
| Consumer-state-id-usa | object<br>Group of data elements tied to US-State-ID. |
| |     |     |
| --- | --- |
| issuingState | string or null <iso3166-2>  \[ 0 .. 2 \] characters <br>2-letter state code that issued ID.<br>Example: "TX" |
| stateIDNumber | string or null \[ 0 .. 30 \] characters <br>Driver's License<br>Example: "4325309845244334" | |
| dateOfBirth | string or null \[ 0 .. 8 \] characters <br>Date of birth of consumer in YYYYMMDD format. If the request is for adding a card holder to an existing card, this DOB is for the additional card holder, NOT the existing card holder.<br>Example: "19720203" |
| email | string or null \[ 0 .. 42 \] characters <br>Applicant's email address. Email address may include only one “@” and must contain at least one “.” after the @.<br>Example: "Test3@Test.com" |
| Ip-address-data | object<br>Consumer IP address captured by subscriber's service/API. |
| |     |     |
| --- | --- |
| ipAddress | string or null \[ 0 .. 39 \] characters <br>IP address of the browser as returned by the HTTP headers (e.g. 111.222.33.44).<br>Example: "101.101.102.103" |
| proxyIP | string or null \[ 0 .. 64 \] characters <br>IP address of the proxy.<br>Example: "100.101.103.103" |
| proxyIPgeoLocation | string or null \[ 0 .. 2 \] characters <br>ISO 3166 country code of the proxy IP address or one of the special codes.<br>Example: "US" |
| proxyIPISP | string or null \[ 0 .. 50 \] characters <br>Internet Service Provider (ISP) the Proxy IP address originates from.<br>Example: "100.101.103.103" |
| proxyType | string or null \[ 0 .. 32 \] characters <br>Used to classify the type, and hence risk of the proxy in real time. Examples:<br>Transparent - proxy is a transparent proxy<br>Anonymous - anonymous proxy was detected<br>Hidden - proxy is trying to avoid detection. This is the highest risk proxy type.<br>Example: "NUMICS1" |
| trueIP | string or null \[ 0 .. 64 \] characters <br>The true client IP Address detected by Device ID vendor.<br>Example: "100.101.103.103" |
| trueIPActivity | string or null \[ 0 .. 64 \] characters <br>Activities associated with IP Address based on infection detection and automated classification. Associated with phishing, spam, malware, peer to peer sharing, etc.<br>Example: "100.101.103.103" |
| trueIPgeoLocation | string or null \[ 0 .. 2 \] characters <br>The ISO 3166 country code of the True IP Address or one of the special codes.<br>Example: "US" |
| trueIPISP | string or null \[ 0 .. 50 \] characters <br>The Internet Service Provider (ISP) that serves the True IP address.<br>Example: "100.101.103.103" | |
| Ssn-or-taxID | object<br>Group of data elements tied to SSN or Tax ID. |
| |     |     |
| --- | --- |
| isSSNTaxid | string or null \[ 0 .. 1 \] characters <br>1 - Tax ID Number. Any other value - SSN.<br>Example: "1" |
| ssnTaxid | string or null \[ 0 .. 9 \] characters <br>SSN or Tax ID.<br>Example: "887601476" | | |
| countryCode | string or null <iso3166-alpha2>  2 characters <br>Country code in ISO 3166-1 alpha-2 format (assumes “US” if not populated).<br>Example: "US" |
| Delete-or-update-key | object<br>Key for deleting or updating previously reported request. |
| |     |     |
| --- | --- |
| originalActivityDate | string or null \[ 0 .. 8 \] characters <br>Required for request type 59 (delete). Date of application activity/Inquiry/fraud in YYYYMMDD format sent on the original request’s request-key that is being deleted.<br>Example: "20210929" |
| originalIssuingBID | string or null \[ 0 .. 8 \] characters <br>Required for request type 59 (delete). Business ID or member ID sent on the original request's request-key that is being deleted or updated. Numeric value.<br>Example: "99901235" |
| originalIssuingBIN | string or null \[ 0 .. 8 \] characters <br>Required for request type 59 (delete). Issuing BIN or Processing ID sent on the original request’s request-key that is being deleted or updated. Will support both 6 and 8 numeric byte Issuing BIN's.<br>Example: "55501235" |
| originalLocatorNumber | string or null \[ 0 .. 11 \] characters <br>Required for request type 59 (delete). Locator number (numeric) sent on the original request’s request-key that is being deleted.<br>Example: "22531066015" | |
| Fraud-report | object<br>Group of data elements tied to fraud report. |
| |     |     |
| --- | --- |
| cardMailedZipCode | string or null \[ 0 .. 9 \] characters <br>Relevant only for fraud/unauthorized use (type 18, 28, 58, 68 or 78) record with UU fraud type code ‘02’, where a consumer reported that card was not received.<br>Five or nine digit ZIP code which card was mailed.<br>Example: "605151111" |
| fraudTypeCode | string or null \[ 0 .. 2 \] characters <br>MUST be present for unauthorized use/fraud (type 18, 28, 58, 68 or 78) record. Account level frauds detected at both acquisition stage and post-booking must be reported by issuers.<br>00 – Fraud loss due to card lost<br>01 – Fraud loss due to card stolen<br>02 – Fraud loss due to card not received<br>03 – Fraud loss due to a fraudulent application<br>04 – Fraud loss due to counterfeit card<br>05 – Fraud loss due to Account takeover<br>06 – Fraud loss due to card not present activity<br>07 – Fraudulent application; consumer verified (pre-booking, no loss)<br>08 – Suspicious application; unable to verify (pre-booking, no loss)<br>09 – Bust out<br>Example: "02" |
| internetFraud_arrestCode | integer or null <= 1 characters <br>Relevant only for fraud/unauthorized use reports (type 18, 28, 58, 68 or 78). Indicates whether the fraud report was tied to an internet originated card application.<br>0 - No arrest; non-Internet application<br>1 - Arrest; non-internet application<br>2 - No arrest; Internet application<br>3 - Arrest; Internet application |
| lawEnforcementCaseNumber | string or null \[ 0 .. 7 \] characters <br>Relevant only for unauthorized use (type 18, 28, 58, 68 or 78) record. If a report was filed with law enforcement, the case number associated with the report.<br>Example: "2340987" | |
| Product-id | object<br>Group of data elements tied to product id. |
| |     |     |
| --- | --- |
| requestCategory | string or null \[ 0 .. 4 \] characters <br>If subscriber request is related to issuing new card or adding services to an existing card, the card type associated with request - credit, debit etc. Value will be numeric.<br>Example: "10" | |
| Request-key | object<br>Group of data elements tied to request key. |
| |     |     |
| --- | --- |
| activityDate<br>required | string 8 characters <br>Date of application activity/Inquiry/fraud in YYYYMMDD format.<br>Example: "20210929" |
| issuingBIN<br>required | string \[ 6 .. 8 \] characters <br>Issuing BIN (Bank Identification Number) or Processing ID assigned by Visa. Values can be 6 or 8 numeric bytes.<br>Example: "55501235" |
| locatorNumber<br>required | string \[ 1 .. 11 \] characters <br>Unique for record by Issuing BIN and date; Must fill all 11 numeric bytes using leading zeros where necessary; May not be spaces or all zeros.<br>Example: "22531066015" |
| internalTraceNumber | string or null \[ 0 .. 6 \] characters <br>Trace number (numeric) within the subscriber's business solution, like application ID. This is not the ID for a JSON request.<br>Example: "333333" |
| issuingBID | string or null \[ 0 .. 8 \] characters <br>Business ID or member ID assigned to subscriber by Visa.<br>Example: "99901235" |
| processorBIN | string or null \[ 0 .. 6 \] characters <br>Processing ID (numeric) if using processor for reporting data.<br>Example: "77701235" |
