Verifications

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

List Merchant Verifications

Get a list of all the Verifications for a Merchant resource.

Request
path Parameters
merchant_id
required
string

ID of Merchant object.

query Parameters
limit
integer <int64>

The number of entries to return.

after_cursor
string

Return every resource created after the cursor value.

before_cursor
string

Return every resource created before the cursor value.

tags.key
string

Filter by the key of a Tag.

tags.value
string

Filter by the value of a Tag.

Responses
200

List of Verification objects

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/merchants/{merchant_id}/verifications
Request samples 
curl https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

List Payment Instrument Verifications

List all the Verifications created for a Payment Instrument.

Request
path Parameters
payment_instrument_id_verify
required
string
query Parameters
limit
integer <int64>

The number of entries to return.

offset
integer <int64>

The number of items to skip before starting to collect the result set.

pageNumber
integer <int64>

The page number to list.

pageSize
integer <int64>

The size of the page.

tags.key
string

Filter by the key of a Tag.

tags.value
string

Filter by the value of a Tag.

Responses
200

List of Verification objects

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/payment_instruments/{payment_instrument_id_verify}
Request samples 
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
Response samples
application/hal+json
{}

List Verifications

Retrieve a list of Verifications.

Request
query Parameters
limit
integer

The numbers of items to return.

Example: limit=10
after_cursor
string

Return every resource created after the cursor value.

before_cursor
string

Return every resource created before the cursor value.

tags.key
string

Filter by the key of a Tag.

tags.value
string

Filter by the value of a Tag.

Responses
200

List of Verification objects

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

get/verifications
Request samples 
curl https://finix.sandbox-payments-api.com/verifications \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Fetch a Verification

Retrieve the details of a Verification.

Request
path Parameters
verification_id
required
string

ID of Verification object.

Responses
200

Single Verification object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/verifications/{verification_id}
Request samples 
curl https://finix.sandbox-payments-api.com/verifications/VIbXwBuccEcqw7rfZneELCv4 \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}