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 "Content-Type: application/vnd.api+json" \ -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 "Content-Type: application/vnd.api+json" \ -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
}
}
Create a Verification
to verify a seller's Identity
.
Verifications can also be created directly on the resources you want to verify. For example:
POST /merchants/{merchant_id}/verifications
POST /payment_instruments/{payment_instrument_id}/verifications
identity | string ID of the |
merchant | string The ID of the |
tags | object or null Include up to 50
(e.g., |
processor | string or null Set the acquiring processor. Avalible values include:
|
Single Verification object
Error
Authentication information is missing or invalid
Forbidden
Not Acceptable
Invalid field
curl https://finix.sandbox-payments-api.com/verifications \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \ -X POST \ -d ' { "identity": "ID2CGJmjqyYaQAu6qyuvGeWK", "merchant": "MUgWbPVvtKbzjKNNGKqdQYV7", "tags": { "card_name": "Business_Card" } }'
{- "id": "VIvZKP8XKzxyJaxJsfAEHbw6",
- "created_at": "2022-10-11T00:46:48.68Z",
- "updated_at": "2022-10-11T00:46:48.72Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "identity": null,
- "merchant": "MUgWbPVvtKbzjKNNGKqdQYV7",
- "merchant_identity": "ID2CGJmjqyYaQAu6qyuvGeWK",
- "messages": [ ],
- "payment_instrument": null,
- "processor": "DUMMY_V1",
- "raw": null,
- "state": "PENDING",
- "tags": {
- "card_name": "Business_Card"
}, - "trace_id": "a7355d05-95b0-4b44-938d-bf0a99f19c17",
- "_links": {
- "application": {
},
}
}
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 "Content-Type: application/vnd.api+json" \ -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 "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "id": "VIvZKP8XKzxyJaxJsfAEHbw6",
- "created_at": "2022-10-11T00:46:48.68Z",
- "updated_at": "2022-10-11T00:46:48.72Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "identity": null,
- "merchant": "MUgWbPVvtKbzjKNNGKqdQYV7",
- "merchant_identity": "ID2CGJmjqyYaQAu6qyuvGeWK",
- "messages": [ ],
- "payment_instrument": null,
- "processor": "DUMMY_V1",
- "raw": null,
- "state": "PENDING",
- "tags": {
- "card_name": "Business_Card"
}, - "trace_id": "a7355d05-95b0-4b44-938d-bf0a99f19c17",
- "_links": {
- "application": {
},
}
}