Sign in

v2

latestOpenAPI 3.0.22026-08-081303782.1 MB
Merchants

Verify a Merchant

Create a Verification on a Merchant to get them Approved. This request will create a new PENDING Verification. Listen to updates and re-fetch the Verification when it is SUCCEEDED or FAILED.

For handling FAILED Verifications, see Fetch a Verification. See also Onboarding Process for Seller Merchants and Verification Requirements for Payouts for Recipient Merchants.

post/merchants/{merchant_id}/verifications

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

object required

Response

A Merchant Verification

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

applicationstring

ID of the Application the resource was created under.

identitystring nullable

The ID of the Identity used to create the Merchant.

merchantstring

The ID of the Merchant sent for verification.

merchant_identitystring

The Identity ID associated with the Merchant.

messagesstring[]

A codified list of reasons the verification request failed.

outcome_summarystring

A message providing additional context about why the verification request failed, available for SELLER merchants only.

outcomesobject[]

A codified list of reasons the verification request failed, available for SELLER merchants only.

payment_instrumentstring

This field is not applicable to merchant verification.

processor'FINIX_V1' | 'DUMMY_V1'

Name of the verification processor.

state'PENDING' | 'FAILED' | 'SUCCEEDED'

The state of the verification request.

tagsTags 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)
trace_idstring

An ID used for tracking the verification request.

type'MERCHANT'

Details the type of resource getting verified.

sub_type'CYBERSOURCE' nullable

Specifies the Gateway Integration linked to the Merchant. If the merchant is not linked to a Gateway Integration, this field will be null. At this time, CYBERSOURCE is the only supported Gateway Integration.