--- title: "Verify CVV, AVS, and Name" method: PUT path: "/payment_instruments/{payment_instrument_id_verify}" tags: ["Payment Instruments"] --- # Verify CVV, AVS, and Name `PUT /payment_instruments/{payment_instrument_id_verify}` Verify a `Payment Instrument` to determine CVV, AVS, and name verification results. {% admonition type="warning" name="PCI Scope Restriction" %} CVV submission is only available to PCI-compliant merchants. Non-PCI customers should not collect and pass CVV in this request. {% /admonition %} ## Request body - union - UpdatePaymentInstrumentVerificationCVV - `merchant` string, required — - The ID of the `Merchant`. - Must be included when `verify_payment_card` is set to **true**. - `security_code` string, nullable, required — The 3-or 4-digit security code for the card (i.e., the CVV code). While providing a CVV is optional, it is recommended to include it wherever possible to prevent fraud. - `verify_payment_card` boolean, required — - Set to **true** to verify card details with the card issuer. - Must be set to **true** to update the CVV or security code of a card. - When set to **true**, `merchant` must also be included with your request. - UpdatePaymentInstrumentVerificationAddress - `address` Address, required - `line1` string, nullable, required — First line of the address (max 35 characters). - `line2` string, nullable — Second line of the address (max 35 characters). - `city` string, nullable, required — City (max 20 characters). - `region` string, nullable, required — 2-letter State code. - `postal_code` string, nullable, required — Zip or Postal code (max 7 characters). - `country` 'ABW' | 'AFG' | 'AGO' | 'AIA' | 'ALA' | 'ALB' | 'AND' | 'ARE' | 'ARG' | 'ARM' | 'ASM' | 'ATA' | 'ATF' | 'ATG' | 'AUS' | 'AUT' | 'AZE' | 'BDI' | 'BEL' | 'BEN' | 'BES' | 'BFA' | 'BGD' | 'BGR' | 'BHR' | 'BHS' | 'BIH' | 'BLM' | 'BLR' | 'BLZ' | 'BMU' | 'BOL' | 'BRA' | 'BRB' | 'BRN' | 'BTN' | 'BVT' | 'BWA' | 'CAF' | 'CAN' | 'CCK' | 'CHE' | 'CHL' | 'CHN' | 'CIV' | 'CMR' | 'COD' | 'COG' | 'COK' | 'COL' | 'COM' | 'CPV' | 'CRI' | 'CUB' | 'CUW' | 'CXR' | 'CYM' | 'CYP' | 'CZE' | 'DEU' | 'DJI' | 'DMA' | 'DNK' | 'DOM' | 'DZA' | 'ECU' | 'EGY' | 'ERI' | 'ESH' | 'ESP' | 'EST' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FRA' | 'FRO' | 'FSM' | 'GAB' | 'GBR' | 'GEO' | 'GGY' | 'GHA' | 'GIB' | 'GIN' | 'GLP' | 'GMB' | 'GNB' | 'GNQ' | 'GRC' | 'GRD' | 'GRL' | 'GTM' | 'GUF' | 'GUM' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IMN' | 'IND' | 'IOT' | 'IRL' | 'IRN' | 'IRQ' | 'ISL' | 'ISR' | 'ITA' | 'JAM' | 'JEY' | 'JOR' | 'JPN' | 'KAZ' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'KNA' | 'KOR' | 'KWT' | 'LAO' | 'LBN' | 'LBR' | 'LBY' | 'LCA' | 'LIE' | 'LKA' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'MAC' | 'MAF' | 'MAR' | 'MCO' | 'MDA' | 'MDG' | 'MDV' | 'MEX' | 'MHL' | 'MKD' | 'MLI' | 'MLT' | 'MMR' | 'MNE' | 'MNG' | 'MNP' | 'MRT' | 'MSR' | 'MTQ' | 'MUS' | 'MWI' | 'MYS' | 'MYT' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NIU' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NZL' | 'OMN' | 'PAK' | 'PAN' | 'PCN' | 'PER' | 'PHL' | 'PLW' | 'PNG' | 'POL' | 'PRI' | 'PRK' | 'PRT' | 'PRY' | 'PSE' | 'PYF' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'SAU' | 'SDN' | 'SEN' | 'SGP' | 'SGS' | 'SHN' | 'SJM' | 'SLB' | 'SLE' | 'SLV' | 'SMR' | 'SOM' | 'SPM' | 'SRB' | 'SSD' | 'STP' | 'SUR' | 'SVK' | 'SVN' | 'SWE' | 'SWZ' | 'SXM' | 'SYC' | 'SYR' | 'TCA' | 'TCD' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TKM' | 'TLS' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TUV' | 'TWN' | 'TZA' | 'UGA' | 'UKR' | 'UMI' | 'URY' | 'USA' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'XKX' | 'YEM' | 'ZAF' | 'ZMB' | 'ZWE', nullable, required - `merchant` string, required — The ID of the `Merchant`. - `verify_payment_card` boolean, required — - Set to **true** to verify the cardholder's address with the card issuer. - When set to **true**, `merchant` must also be included with your request. - UpdatePaymentInstrumentVerificationName - `merchant` string, required — - The ID of the `Merchant`. - Must be included when `verify_payment_card` is set to **true**. - `name_verification_details` object, required — The cardholder name details to verify against the card issuer. Only supported on `FINIX_V1`. {% admonition type="info" %} When provided, the `name` field on the `Payment Instrument` is updated by concatenating `first_name`, `middle_name`, and `last_name`. {% /admonition %} - `first_name` string, required — The cardholder's first name. - `last_name` string, required — The cardholder's last name. - `middle_name` string — The cardholder's middle name. - `verify_payment_card` boolean, required — - Set to **true** to verify card details with the card issuer. - When set to **true**, `merchant` must also be included with your request. ## Response `200` A single Payment Instrument. - PaymentInstrumentCard - `id` string — The ID of the resource. - `created_at` string, date-time — Timestamp of when the object was created. - `updated_at` string, date-time — Timestamp of when the object was last updated. - `created_via` 'API' — The method by which the resource was created. - `account_updater_enabled` boolean — When enabled, Finix automatically checks for updates with card networks. This Account Updater functionality: - Automatically updates card details (e.g., number or expiration date) to maintain continuity of charges, increasing authorization rates. - Saves the cardholder the hassle of updating card details across `Merchants` for each of their `Subscriptions`. **Note**: Cards created before the feature is enabled are unaffected by default. To include these cards, you can manually enable the Account Updater functionality for each card individually using a PUT request. Once enabled, you can link the card to this API call to trigger updates with card networks. - `address` Address - `line1` string, nullable, required — First line of the address (max 35 characters). - `line2` string, nullable — Second line of the address (max 35 characters). - `city` string, nullable, required — City (max 20 characters). - `region` string, nullable, required — 2-letter State code. - `postal_code` string, nullable, required — Zip or Postal code (max 7 characters). - `country` 'ABW' | 'AFG' | 'AGO' | 'AIA' | 'ALA' | 'ALB' | 'AND' | 'ARE' | 'ARG' | 'ARM' | 'ASM' | 'ATA' | 'ATF' | 'ATG' | 'AUS' | 'AUT' | 'AZE' | 'BDI' | 'BEL' | 'BEN' | 'BES' | 'BFA' | 'BGD' | 'BGR' | 'BHR' | 'BHS' | 'BIH' | 'BLM' | 'BLR' | 'BLZ' | 'BMU' | 'BOL' | 'BRA' | 'BRB' | 'BRN' | 'BTN' | 'BVT' | 'BWA' | 'CAF' | 'CAN' | 'CCK' | 'CHE' | 'CHL' | 'CHN' | 'CIV' | 'CMR' | 'COD' | 'COG' | 'COK' | 'COL' | 'COM' | 'CPV' | 'CRI' | 'CUB' | 'CUW' | 'CXR' | 'CYM' | 'CYP' | 'CZE' | 'DEU' | 'DJI' | 'DMA' | 'DNK' | 'DOM' | 'DZA' | 'ECU' | 'EGY' | 'ERI' | 'ESH' | 'ESP' | 'EST' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FRA' | 'FRO' | 'FSM' | 'GAB' | 'GBR' | 'GEO' | 'GGY' | 'GHA' | 'GIB' | 'GIN' | 'GLP' | 'GMB' | 'GNB' | 'GNQ' | 'GRC' | 'GRD' | 'GRL' | 'GTM' | 'GUF' | 'GUM' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IMN' | 'IND' | 'IOT' | 'IRL' | 'IRN' | 'IRQ' | 'ISL' | 'ISR' | 'ITA' | 'JAM' | 'JEY' | 'JOR' | 'JPN' | 'KAZ' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'KNA' | 'KOR' | 'KWT' | 'LAO' | 'LBN' | 'LBR' | 'LBY' | 'LCA' | 'LIE' | 'LKA' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'MAC' | 'MAF' | 'MAR' | 'MCO' | 'MDA' | 'MDG' | 'MDV' | 'MEX' | 'MHL' | 'MKD' | 'MLI' | 'MLT' | 'MMR' | 'MNE' | 'MNG' | 'MNP' | 'MRT' | 'MSR' | 'MTQ' | 'MUS' | 'MWI' | 'MYS' | 'MYT' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NIU' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NZL' | 'OMN' | 'PAK' | 'PAN' | 'PCN' | 'PER' | 'PHL' | 'PLW' | 'PNG' | 'POL' | 'PRI' | 'PRK' | 'PRT' | 'PRY' | 'PSE' | 'PYF' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'SAU' | 'SDN' | 'SEN' | 'SGP' | 'SGS' | 'SHN' | 'SJM' | 'SLB' | 'SLE' | 'SLV' | 'SMR' | 'SOM' | 'SPM' | 'SRB' | 'SSD' | 'STP' | 'SUR' | 'SVK' | 'SVN' | 'SWE' | 'SWZ' | 'SXM' | 'SYC' | 'SYR' | 'TCA' | 'TCD' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TKM' | 'TLS' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TUV' | 'TWN' | 'TZA' | 'UGA' | 'UKR' | 'UMI' | 'URY' | 'USA' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'XKX' | 'YEM' | 'ZAF' | 'ZMB' | 'ZWE', nullable, required - `address_verification` 'POSTAL_CODE_AND_STREET_MATCH' | 'STREET_MATCH' | 'POSTAL_CODE_MATCH' | 'NO_ADDRESS' | 'NO_MATCH' | 'NOT_SUPPORTED' | 'UNKNOWN' — - Details the results of verifying `address` with the issuing bank. - Set to **UNKNOWN** when `address` gets updated. - `application` string — ID of the `Application` the resource was created under. - `bin` string — Bank Identification number for the `Payment Instrument`. - `brand` 'UNKNOWN' | 'DINERS_CLUB_INTERNATIONAL' | 'DANKORT' | 'MIR' | 'TROY' | 'UATP' | 'CHINA_T_UNION' | 'CHINA_UNION_PAY' | 'AMERICAN_EXPRESS' | 'VERVE' | 'RUPAY' | 'DISCOVER' | 'JCB' | 'MASTERCARD' | 'INTERPAYMENT' | 'INSTAPAYMENT' | 'MAESTRO' | 'VISA' | 'LANKAPAY' | 'DINERS_CLUB' | 'INTERAC' — The `brand` of the card saved in the `Payment Instrument`. - `card_type` 'CREDIT' | 'DEBIT' | 'HSA_FSA' | 'NON_RELOADABLE_PREPAID' | 'RELOADABLE_PREPAID' | 'UNKNOWN' — The type of payment card saved in the `Payment Instrument`. - `country` 'ABW' | 'AFG' | 'AGO' | 'AIA' | 'ALA' | 'ALB' | 'AND' | 'ARE' | 'ARG' | 'ARM' | 'ASM' | 'ATA' | 'ATF' | 'ATG' | 'AUS' | 'AUT' | 'AZE' | 'BDI' | 'BEL' | 'BEN' | 'BES' | 'BFA' | 'BGD' | 'BGR' | 'BHR' | 'BHS' | 'BIH' | 'BLM' | 'BLR' | 'BLZ' | 'BMU' | 'BOL' | 'BRA' | 'BRB' | 'BRN' | 'BTN' | 'BVT' | 'BWA' | 'CAF' | 'CAN' | 'CCK' | 'CHE' | 'CHL' | 'CHN' | 'CIV' | 'CMR' | 'COD' | 'COG' | 'COK' | 'COL' | 'COM' | 'CPV' | 'CRI' | 'CUB' | 'CUW' | 'CXR' | 'CYM' | 'CYP' | 'CZE' | 'DEU' | 'DJI' | 'DMA' | 'DNK' | 'DOM' | 'DZA' | 'ECU' | 'EGY' | 'ERI' | 'ESH' | 'ESP' | 'EST' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FRA' | 'FRO' | 'FSM' | 'GAB' | 'GBR' | 'GEO' | 'GGY' | 'GHA' | 'GIB' | 'GIN' | 'GLP' | 'GMB' | 'GNB' | 'GNQ' | 'GRC' | 'GRD' | 'GRL' | 'GTM' | 'GUF' | 'GUM' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IMN' | 'IND' | 'IOT' | 'IRL' | 'IRN' | 'IRQ' | 'ISL' | 'ISR' | 'ITA' | 'JAM' | 'JEY' | 'JOR' | 'JPN' | 'KAZ' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'KNA' | 'KOR' | 'KWT' | 'LAO' | 'LBN' | 'LBR' | 'LBY' | 'LCA' | 'LIE' | 'LKA' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'MAC' | 'MAF' | 'MAR' | 'MCO' | 'MDA' | 'MDG' | 'MDV' | 'MEX' | 'MHL' | 'MKD' | 'MLI' | 'MLT' | 'MMR' | 'MNE' | 'MNG' | 'MNP' | 'MRT' | 'MSR' | 'MTQ' | 'MUS' | 'MWI' | 'MYS' | 'MYT' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NIU' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NZL' | 'OMN' | 'PAK' | 'PAN' | 'PCN' | 'PER' | 'PHL' | 'PLW' | 'PNG' | 'POL' | 'PRI' | 'PRK' | 'PRT' | 'PRY' | 'PSE' | 'PYF' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'SAU' | 'SDN' | 'SEN' | 'SGP' | 'SGS' | 'SHN' | 'SJM' | 'SLB' | 'SLE' | 'SLV' | 'SMR' | 'SOM' | 'SPM' | 'SRB' | 'SSD' | 'STP' | 'SUR' | 'SVK' | 'SVN' | 'SWE' | 'SWZ' | 'SXM' | 'SYC' | 'SYR' | 'TCA' | 'TCD' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TKM' | 'TLS' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TUV' | 'TWN' | 'TZA' | 'UGA' | 'UKR' | 'UMI' | 'URY' | 'USA' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'XKX' | 'YEM' | 'ZAF' | 'ZMB' | 'ZWE', nullable - `currency` 'CAD' | 'USD' — ISO 4217 3-letter currency code. - `disabled_code` 'CARD_ACCOUNT_CLOSED' | 'INVALID_ACCOUNT_NUMBER' | 'LOST_OR_STOLEN_CARD' | 'NON_RELOADABLE_INSUFFICIENT_FUNDS' | 'PICK_UP_CARD' | 'RESTRICTED_CARD' | 'USER_INITIATED', nullable — A code indicating why the `Payment Instrument` was disabled. This field is set when: - The system automatically disables the `Payment Instrument`. - A user manually disables it (returns `USER_INITIATED`). See `disabled_message` for all possible codes and their descriptions. - `disabled_message` string, nullable — A human-readable message explaining why the `Payment Instrument` was disabled. This field provides additional context for the `disabled_code`. The possible error codes/messages are: - `CARD_ACCOUNT_CLOSED`: "The card account has been closed. The card has been disabled to prevent further use." - `INVALID_ACCOUNT_NUMBER`: "The card number is not valid. The card has been disabled to prevent further use." - `LOST_OR_STOLEN_CARD`: "The card is reported lost or stolen. The card has been disabled to prevent further use." - `NON_RELOADABLE_INSUFFICIENT_FUNDS`: "The card has insufficient funds for the transaction and is non-reloadable. The card has been disabled to prevent further use." - `PICK_UP_CARD`: "The card is reported lost or stolen. The card has been disabled to prevent further use." - `RESTRICTED_CARD`: "The card has a restriction preventing approval for this transaction. The card has been disabled to prevent further use." - `USER_INITIATED`: "The card has been disabled by a user." - `enabled` boolean — Indicates whether the `Payment Instrument` resource is enabled. The default value is `true`; set it to `false` to disable the `Payment Instrument`. The user or the system can update this field to enable or disable the payment instrument. - `expiration_month` integer — Expiration month (e.g. 12 for December). - `expiration_year` integer — 4-digit expiration year. - `fast_funds_indicator` string — Details if Fast Funds is enabled for the card. - `fingerprint` string — Unique ID that represents the tokenized card data. - `identity` string — The ID of the `Identity` used to create the resource. - `instrument_type` 'PAYMENT_CARD' | 'PAYMENT_CARD_PRESENT' | 'TOKEN' — The type of `Payment Instrument`. - `issuer_country` 'ABW' | 'AFG' | 'AGO' | 'AIA' | 'ALA' | 'ALB' | 'AND' | 'ARE' | 'ARG' | 'ARM' | 'ASM' | 'ATA' | 'ATF' | 'ATG' | 'AUS' | 'AUT' | 'AZE' | 'BDI' | 'BEL' | 'BEN' | 'BES' | 'BFA' | 'BGD' | 'BGR' | 'BHR' | 'BHS' | 'BIH' | 'BLM' | 'BLR' | 'BLZ' | 'BMU' | 'BOL' | 'BRA' | 'BRB' | 'BRN' | 'BTN' | 'BVT' | 'BWA' | 'CAF' | 'CAN' | 'CCK' | 'CHE' | 'CHL' | 'CHN' | 'CIV' | 'CMR' | 'COD' | 'COG' | 'COK' | 'COL' | 'COM' | 'CPV' | 'CRI' | 'CUB' | 'CUW' | 'CXR' | 'CYM' | 'CYP' | 'CZE' | 'DEU' | 'DJI' | 'DMA' | 'DNK' | 'DOM' | 'DZA' | 'ECU' | 'EGY' | 'ERI' | 'ESH' | 'ESP' | 'EST' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FRA' | 'FRO' | 'FSM' | 'GAB' | 'GBR' | 'GEO' | 'GGY' | 'GHA' | 'GIB' | 'GIN' | 'GLP' | 'GMB' | 'GNB' | 'GNQ' | 'GRC' | 'GRD' | 'GRL' | 'GTM' | 'GUF' | 'GUM' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IMN' | 'IND' | 'IOT' | 'IRL' | 'IRN' | 'IRQ' | 'ISL' | 'ISR' | 'ITA' | 'JAM' | 'JEY' | 'JOR' | 'JPN' | 'KAZ' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'KNA' | 'KOR' | 'KWT' | 'LAO' | 'LBN' | 'LBR' | 'LBY' | 'LCA' | 'LIE' | 'LKA' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'MAC' | 'MAF' | 'MAR' | 'MCO' | 'MDA' | 'MDG' | 'MDV' | 'MEX' | 'MHL' | 'MKD' | 'MLI' | 'MLT' | 'MMR' | 'MNE' | 'MNG' | 'MNP' | 'MOZ' | 'MRT' | 'MSR' | 'MTQ' | 'MUS' | 'MWI' | 'MYS' | 'MYT' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NIU' | 'NLD' | 'NON_USA' | 'NOR' | 'NPL' | 'NRU' | 'NZL' | 'OMN' | 'PAK' | 'PAN' | 'PCN' | 'PER' | 'PHL' | 'PLW' | 'PNG' | 'POL' | 'PRI' | 'PRK' | 'PRT' | 'PRY' | 'PSE' | 'PYF' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'SAU' | 'SDN' | 'SEN' | 'SGP' | 'SGS' | 'SHN' | 'SJM' | 'SLB' | 'SLE' | 'SLV' | 'SMR' | 'SOM' | 'SPM' | 'SRB' | 'SSD' | 'STP' | 'SUR' | 'SVK' | 'SVN' | 'SWE' | 'SWZ' | 'SXM' | 'SYC' | 'SYR' | 'TCA' | 'TCD' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TKM' | 'TLS' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TUV' | 'TWN' | 'TZA' | 'UGA' | 'UKR' | 'UMI' | 'UNKNOWN' | 'URY' | 'USA' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'YEM' | 'ZAF' | 'ZMB' | 'ZWE' — The Alpha-3 Code of the country the card was issued in. In addition, the following values are possible: - `NON_USA` - The card was issued outside of the United States. - `UNKNOWN` - The processor did not return an issuer country for this particular BIN. - `last_four` string — Last four digits of the card. - `name` string, nullable — The name of the card owner. - `network_token_enabled` boolean — When enabled, a "network token" replaces raw card details (e.g., the 16-digit PAN and expiration date) for transactions. Network tokens have several benefits: - The token offers increased authorization rates, even for lost or stolen cards, as it remains valid while the physical card is replaced. - Visa reduces interchange fees when using network tokens. - Tokens enhance security by replacing card details with a non-sensitive string that is usable only within the Finix system. **Note**: Cards created before the feature is enabled are unaffected. To include them, update the individual `Payment Instrument` to set `network_token_enabled` to `true`. - `network_token_state` 'ACTIVE' | 'CLOSED' | 'FAILED' | 'NOT_ENABLED' | 'SUSPENDED' | 'PENDING' — The state of the network token. The possible enum values are as follows: - `NOT_ENABLED`: The `network_token_state` is `NOT_ENABLED` when the value of `network_token_enabled` on the `Payment Instrument` is `false`. - `PENDING`: Immediately after Finix enables network tokens for a specific card, `network_token_state` is initially set to `PENDING`. - `ACTIVE`: After Finix receives the network token successfully from the card network, `network_token_state` updates to `ACTIVE`. - `FAILED`: In the event that there is an issue with the card network such as service becomes unavailable, `FAILED` is returned. - `SUSPENDED`: When the issuing bank does not allow the network token to be used in transactions, `SUSPENDED` is returned. - `CLOSED`: In the event that the issuing bank has closed the card permanently, `CLOSED` is returned. - `payload_type` 'SOURCE' | 'DESTINATION' - `push_funds_block_indicator` string — Details if the card is enabled to receive push-to-card disbursements. - `name_verification_results` NameVerificationResults, nullable - `first_name_verification` 'MATCH' | 'NO_MATCH' | 'NOT_SUPPORTED' | 'PARTIAL_MATCH' | 'UNKNOWN' — The result of verifying the cardholder's first name. - `last_name_verification` 'MATCH' | 'NO_MATCH' | 'NOT_SUPPORTED' | 'PARTIAL_MATCH' | 'UNKNOWN' — The result of verifying the cardholder's last name. - `middle_name_verification` 'MATCH' | 'NO_MATCH' | 'NOT_SUPPORTED' | 'PARTIAL_MATCH' | 'UNKNOWN' — The result of verifying the cardholder's middle name. - `name_verification` 'MATCH' | 'NO_MATCH' | 'NOT_SUPPORTED' | 'PARTIAL_MATCH' | 'UNKNOWN' — The result of verifying the cardholder's full name. - `security_code_verification` 'MATCHED' | 'UNKNOWN' | 'UNMATCHED' — Details the results of the Card Verification Code check. - `tags` Tags, nullable — Include up to 50 `key: value` pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual `values` is 500. (For example, `order_number: 25`, `item_type: produce`, `department: sales`) - `third_party` string, nullable — This field is not applicable to payment cards. - `third_party_token` string, nullable — This field is not applicable to payment cards. - `type` 'PAYMENT_CARD' | 'TOKEN' | 'GOOGLE_PAY' | 'APPLE_PAY' — Type of `Payment Instrument`. - `_links` object — For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs. - `application` object — Link to the `Application` the request was made under. - `href` string - `authorizations` object — Link to the `Authorizations` created under the resource. - `href` string - `identity` object — Link to the `Identity` the request was made under. - `href` string - `self` object — Link to the resource that was used in the request. - `href` string - `transfers` object — Link to the `Transfers` created under the resource. - `href` string - `updates` object — Link to the `Updates` created under the resource. - `href` string - `verifications` object — Link to the `Verification` that was used to verify the `Merchant` that the request was made under. - `href` string ## Other responses - `400` — Bad Request. The server cannot process the request due to malformed syntax or invalid data. - `401` — Unauthorized. Authentication is required and has failed or has not been provided. - `403` — Forbidden. The client is authenticated but does not have permission to access the resource. - `404` — Not Found. The requested resource could not be found on the server. - `406` — Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted. --- [API](https://skmtc.net/finix/apis/finix-api-reference.md) · [All operations](https://skmtc.net/finix/apis/finix-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/finix/finix-api-reference/versions/5426f6f99c52/schema)