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.

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
required
string

ID of Payment Instrument object.

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.

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}/verifications
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
{}

Create a Merchant Verification

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
Request
Request Body schema: application/hal+json
identity
string

ID of the Identity resource associated with the Merchant.

merchant
string

The ID of the Merchant.

tags
object or null

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.

(e.g., order number: 25, item_type: produce, department: sales, etc.)

processor
string or null

Set the acquiring processor. Avalible values include:

  • DUMMY_V1
  • LITLE_V1
  • MASTERCARD_V1
  • VISA_V1
  • NMI_V1
  • VANTIV_V1
Use DUMMY_V1 or null to use your sandbox. For more details on which processor to use, reach out to your Finix point of contact or email Finix Support.

Responses
201

Single Verification object

400

Error

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

422

Invalid field

post/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 \
  -X POST \
  -d '
  {
    "identity": "ID2CGJmjqyYaQAu6qyuvGeWK",
    "merchant": "MUgWbPVvtKbzjKNNGKqdQYV7",
    "tags": {
      "card_name": "Business_Card"
    }
  }'
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.

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
{}