Verifications
are used to verify Identities
and Payment Instruments
.
For Identities
, a verification represents an attempt to onboard and underwrite an identity.
For Payment Instruments
, a verification represents getting additional information from the card brands to verify a card is eligible for push to card.
Related Guides: Onboarding with the API, Push to Card
Get a list of all the Verifications
for a Merchant
resource.
List of Verification objects
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl "https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications" \ -H "Finix-Version: 2022-02-01" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "_embedded": {
- "verifications": [
- {
- "id": "VInHzhoRAnAizVU7jcj2K6bX",
- "created_at": "2022-08-15T23:12:56.40Z",
- "updated_at": "2022-08-15T23:12:56.85Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "identity": null,
- "merchant": "MUpaGK5dUb2Sb7aGuXhFRNbj",
- "merchant_identity": "IDgahPGJ6hangmVJwrMRyZzr",
- "messages": [ ],
- "payment_instrument": null,
- "processor": "DUMMY_V1",
- "raw": "RawDummyMerchantUnderwriteResult",
- "state": "SUCCEEDED",
- "tags": { },
- "trace_id": "1c8fb49d-6f1c-40a0-8646-1bcb88047583",
- "_links": {
- "application": {
},
}
}, - {
- "id": "VIdS8qSW3kZbnK9AsFHJZ81U",
- "created_at": "2022-08-15T23:12:54.32Z",
- "updated_at": "2022-08-15T23:12:54.65Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "identity": null,
- "merchant": "MUpaGK5dUb2Sb7aGuXhFRNbj",
- "merchant_identity": "IDgahPGJ6hangmVJwrMRyZzr",
- "messages": [ ],
- "payment_instrument": null,
- "processor": "DUMMY_V1",
- "raw": "RawDummyMerchantUnderwriteResult",
- "state": "SUCCEEDED",
- "tags": {
- "key": "value_2"
}, - "trace_id": "4d12cbe6-032d-4e9d-8291-ce16f4add412",
- "_links": {
- "application": {
},
}
}
]
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 2
}
}
List all the Verifications
created for a Payment Instrument
.
List of Verification objects
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl "https://finix.sandbox-payments-api.com/payment_instruments/PImc5nvdnp15atLxEBAGtxJs/verifications/" \ -H "Finix-Version: 2022-02-01" \ -u USpEbizhxFRAFT7oYgWjX87B:6d3ace2c-23f9-4e59-8b75-a1a5b8a53055
{- "_embedded": {
- "verifications": [
- {
- "id": "VInHzhoRAnAizVU7jcj2K6bX",
- "created_at": "2022-08-15T23:12:56.40Z",
- "updated_at": "2022-08-15T23:12:56.85Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "identity": null,
- "merchant": "MUpaGK5dUb2Sb7aGuXhFRNbj",
- "merchant_identity": "IDgahPGJ6hangmVJwrMRyZzr",
- "messages": [ ],
- "payment_instrument": null,
- "processor": "DUMMY_V1",
- "raw": "RawDummyMerchantUnderwriteResult",
- "state": "SUCCEEDED",
- "tags": { },
- "trace_id": "1c8fb49d-6f1c-40a0-8646-1bcb88047583",
- "_links": {
- "application": {
},
}
}, - {
- "id": "VIdS8qSW3kZbnK9AsFHJZ81U",
- "created_at": "2022-08-15T23:12:54.32Z",
- "updated_at": "2022-08-15T23:12:54.65Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "identity": null,
- "merchant": "MUpaGK5dUb2Sb7aGuXhFRNbj",
- "merchant_identity": "IDgahPGJ6hangmVJwrMRyZzr",
- "messages": [ ],
- "payment_instrument": null,
- "processor": "DUMMY_V1",
- "raw": "RawDummyMerchantUnderwriteResult",
- "state": "SUCCEEDED",
- "tags": {
- "key": "value_2"
}, - "trace_id": "4d12cbe6-032d-4e9d-8291-ce16f4add412",
- "_links": {
- "application": {
},
}
}
]
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 2
}
}
Retrieve a list of Verifications
.
List of Verification objects
Authentication information is missing or invalid
Forbidden
Not Acceptable
curl "https://finix.sandbox-payments-api.com/verifications" \ -H "Finix-Version: 2022-02-01" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "_embedded": {
- "verifications": [
- {
- "id": "VInHzhoRAnAizVU7jcj2K6bX",
- "created_at": "2022-08-15T23:12:56.40Z",
- "updated_at": "2022-08-15T23:12:56.85Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "identity": null,
- "merchant": "MUpaGK5dUb2Sb7aGuXhFRNbj",
- "merchant_identity": "IDgahPGJ6hangmVJwrMRyZzr",
- "messages": [ ],
- "payment_instrument": null,
- "processor": "DUMMY_V1",
- "raw": "RawDummyMerchantUnderwriteResult",
- "state": "SUCCEEDED",
- "tags": { },
- "trace_id": "1c8fb49d-6f1c-40a0-8646-1bcb88047583",
- "_links": {
- "application": {
},
}
}, - {
- "id": "VIdS8qSW3kZbnK9AsFHJZ81U",
- "created_at": "2022-08-15T23:12:54.32Z",
- "updated_at": "2022-08-15T23:12:54.65Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "identity": null,
- "merchant": "MUpaGK5dUb2Sb7aGuXhFRNbj",
- "merchant_identity": "IDgahPGJ6hangmVJwrMRyZzr",
- "messages": [ ],
- "payment_instrument": null,
- "processor": "DUMMY_V1",
- "raw": "RawDummyMerchantUnderwriteResult",
- "state": "SUCCEEDED",
- "tags": {
- "key": "value_2"
}, - "trace_id": "4d12cbe6-032d-4e9d-8291-ce16f4add412",
- "_links": {
- "application": {
},
}
}
]
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 2
}
}
Retrieve the details of a Verification
.
Single Verification object
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl "https://finix.sandbox-payments-api.com/verifications/VIbXwBuccEcqw7rfZneELCv4" \ -H "Finix-Version: 2022-02-01" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "id": "PIwWisLuZNwPBoLbCgQVTCoY",
- "created_at": "2022-08-15T23:13:06.13Z",
- "updated_at": "2023-10-05T14:50:31.58Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "created_via": "API",
- "currency": "USD",
- "disabled_code": null,
- "disabled_message": null,
- "enabled": true,
- "fingerprint": "FPRmYp7ejhA3yDjSor4A5Ji2D",
- "identity": "IDgWxBhfGYLLdkhxx2ddYf9K",
- "instrument_type": "PAYMENT_CARD",
- "address": {
- "line1": "900 Metro Center Blv",
- "line2": null,
- "city": "San Francisco",
- "region": "CA",
- "postal_code": "94404",
- "country": "CHN"
}, - "address_verification": "NO_MATCH",
- "bin": "400000",
- "brand": "VISA",
- "card_type": "UNKNOWN",
- "expiration_month": 12,
- "expiration_year": 2029,
- "issuer_country": "UNKNOWN",
- "last_four": "9979",
- "name": "Amy White",
- "security_code_verification": "UNMATCHED",
- "tags": {
- "card_name": "Business_Card",
- "quote": "qu`te",
- "qu`ote": "qu`te",
- "custom_key": "custome value"
}, - "type": "PAYMENT_CARD",
- "_links": {
- "self": {
}, - "authorizations": {
}, - "transfers": {
}, - "verifications": {
}, - "application": {
}, - "updates": {
}
}
}