LogoLogo
API ReferencesGithubSupport CenterStatus pageBecome a Partner
  • Getting Started
    • Welcome
    • Our Products
  • Integration Process
  • Devices
    • Dejavoo
    • PAX
    • ID TECH
  • Become a Partner
  • Developer Resources
    • Overview
    • Sandbox & Production Environments
  • Testing Integration
    • Test Cards & ACH Accounts
    • Onboarding API Result Codes
    • Transaction Error Generation Data
    • Card Response & Result Codes
      • Card Error Response Codes
      • Card Transaction Result Codes
      • CSC Response Codes
      • AVS Response Codes
      • Duplicate Transaction Settings
    • ACH Request Validation & Return Codes
      • ACH Request Validation Codes
      • ACH Return Codes
  • API Catalog
    • Merchant Onboarding APIs
    • Transaction (Quest) APIs
    • Automated Merchant Onboarding Setup API
    • Reporting API
  • Webhooks
    • Prerequisites
    • Register Endpoint
    • Webhook Subscriptions
    • Working with Webhooks
      • Transaction Webhook
      • Onboarding Webhooks
        • Application Status
        • Application Fixes
      • Equipment Tracking & Activation Webhooks
        • Equipment Tracking
        • Equipment Activation
  • Merchant Onboarding
    • Overview
  • Automated Merchant Onboarding
    • Prerequisites
    • Working with Automated Merchant Onboarding
      • Generating a Merchant Application
      • Completing the Application
      • Modifying Default Merchant Pricing
        • Retrieving Existing Pricing Templates
        • Modifying Pricing Fees & Completing Merchant Application Record
    • Merchant Onboarding Status Webhooks
    • Configuring Automated Merchant Onboarding
  • Merchant Onboarding via Partner Portal
    • Starting New Application
    • Adding Hierarchy & Compensation Details
    • Entering Business Information
    • Entering Profile Details
    • Conducting the Site Survey
    • Configuring Pricing Details
    • Adding Banking Information
    • Adding Equipment
    • Submitting Signature
    • Reviewing & Submitting Application
    • Viewing Application Summary
  • Merchant Onboarding via API
    • Prerequisites
    • Understanding Integration
    • Working with Merchant Onboarding API
      • Creating a Merchant Profile
      • Completing the Merchant Application
        • Gathering Merchant Demographics
        • Configuring Merchant Pricing
        • Ordering and Setting Up Equipment
      • Submitting the Signature
      • Submitting the Application
  • Payment Processing Solutions
    • Overview
    • Cloud EMV
      • Working with Cloud EMV
        • Direct Data Transfer to Clearent's Cloud
        • Payment Authorization Process via Clearent's Quest Payment Gateway
    • JavaScript SDK
      • Prerequisites
        • Browser Support
      • Working with JavaScript SDK
        • Adding the Payment Form
        • Formatting the Payment Form
        • Processing the Payment
        • Apple Pay for Web
        • Google Pay for Web
        • Using IDTech VP8300
      • Card Validations
        • Card Number Validation
        • Card Expiration Date Validation
        • Card CSC/CVC Validation
      • Configuring with JavaScript SDK
        • Using Members
        • Using Methods
  • Hosted Payments
    • Prerequisites
      • Browser Support
    • Working with Hosted Payments
      • Configuring the Pay Now Button
      • Configuring Payment Page with an Amount Field
      • Configuring Payment Page with an Optional Billing Address and Headline Text
      • Configuring Payment Page with the Save Card Option
      • Configuring the Add Payment Method Button
      • Styling Your Brand on the Payment Page
      • Configuring Apple Pay for Web
      • Configuring Hosted Payment Page Using Members
      • Configuring Hosted Payment Page Using Methods
      • Configuring Hosted Payment Page Using Functions
    • Transaction Responses
      • Successful Transaction Response
      • Successful Transaction Response for a Billing Address
      • Failed Transaction Response
      • Unauthorized Request Response
      • Successful Transaction Response for a Token
      • Successful Token Request Response
    • Response Validations
      • Successful Transaction Response Validation
      • Failed Transaction Response Validation
    • Card Validations
  • Mobile EMV SDK
    • VP3300 Mobile Card Reader
      • Charging the card reader
      • Reading the card data
    • iOS Framework
      • iOS Framework Pre-requisites
      • Processing payments in your iOS app
        • Optional settings
        • Starting a Bluetooth connection
        • Pairing the card reader with an iOS device
        • Integrating the iOS framework into your app
        • Setting up the iOS framework in your Objective-C app
        • Starting a transaction in your iOS app
        • Receiving feedback messages
    • Android Framework
      • Integrating the Android framework into your app
      • Additional settings
      • Generating a JSON Web Token
      • Disabling default EMV configuration
  • ACH Transactions
    • Submitting the payment request
    • Creating an ACH token
    • Getting an ACH transaction
    • ACH transaction statuses
    • ACH transaction return codes
  • Paylink
    • Getting the paylink settings
    • Creating the Paylink
    • Sending the paylink
    • Paylink URL
  • Virtual Terminal
    • Working with the Virtual Terminal
      • Accessing Virtual Terminal
      • Adding or Ordering the Equipment
      • Recurring Payments
        • Adding a New Customer
        • Adding a Payment Method
        • Adding a New Payment Plan
        • Viewing the Plans
      • Processing Sales Transaction
      • Processing ACH Transaction
      • Transaction Search
        • Viewing Transactions
        • Viewing Transaction Receipt
        • Printing Transaction Receipt
        • Emailing Transaction Receipt
        • Void a Transaction
        • Refund a Transaction
        • Processing Pending Transactions
      • Open Batches
        • Viewing Batches
      • VT Settings
        • Merchant
        • Terminal
        • External Terminal
        • Address Verification (AVS)
        • Card Security Code (CSC)
        • Hosted Payment Page (HPP)
  • Financial Management
    • Overview
    • Merchant Pricing
  • Merchant Billing & Funding
  • Financial Reporting
  • Disputes Management
    • Understanding Disputes
    • Managing Disputes via Merchant Portal
    • Managing Disputes via API (Pilot Mode)
  • Reporting
    • Overview
  • Reporting Solutions
  • Working with Reporting API
    • Accessing Reports
    • Retrieving Reports
    • Exporting Reports
  • Support Ticketing
    • Overview
    • Benefits of Support Ticketing System
    • Accessing Support in the Portals
    • Working with Support Ticketing via Partner Portal
      • Types of Support Tickets
      • Submitting a Support Ticket via Partner Portal
  • Working with Support Ticketing via Merchant Portal
    • Types of Support Tickets
    • Submitting a Support Ticket via Merchant Portal
  • Partner & Merchant Solutions
    • Overview
    • Accessing the Portals
    • Navigating the User Interface
    • Working with the Partner Portal
      • Monitoring Performance with Dashboards
      • Managing Merchant Applications
      • Managing Merchants
      • Accessing Reports & Managing Subscriptions
        • Accessing Reports
        • Managing Subscriptions
      • Submitting a Support Ticket
  • Working with the Merchant Portal
    • Monitoring Home Page
    • Accessing Batches
    • Managing Transactions
    • Managing Funding Transactions
    • Managing Virtual Terminal
    • Viewing Chargebacks
    • Managing Disputes
    • Managing Statements & Tax Forms
    • Managing Account Settings
    • Managing User Notifications
    • Managing Support Tickets
  • Security Solutions
    • Overview
    • PCI Compliance
    • Tokenization
    • Encryption
    • Advanced Compliance & Security Measures & Programs
Powered by GitBook

Resources

  • Contact
  • Support Site
  • Campus

Terms & Policies

  • Terms
  • Privacy Policy
  • Disclosures
  • Merchant Agreement

Cookies

  • Cookie List
  • Cookies Settings

Site Info

  • Sitemap

© 2025 Clearent, LLC is a registered agent for Central Bank of St. Louis, MO; Citizens Bank, N.A., Providence, RI; and Pathward, N.A., Sioux Falls, SD.

On this page
  • 1. Create New Merchant Account
  • 2. Add Merchant Demographics Information

Was this helpful?

Export as PDF
  1. Merchant Onboarding via API
  2. Working with Merchant Onboarding API
  3. Completing the Merchant Application

Gathering Merchant Demographics

Clearent collects detailed demographic information to create a comprehensive profile for each business. This helps us understand the operational structure, compliance requirements, and financial needs of the applicant.

The process includes two steps:

1. Create New Merchant Account

Create Merchant

A registered applicant must call the ‘Create Merchant’ endpoint to create new merchant accounts within the application. It validates the provided business model with essential fields such as dbaName, hierarchyNodeKey, and userName. This endpoint uses the POST method to submit and store all critical merchant information, ensuring streamlined operations throughout their lifecycle.

POST https - api/demographics/v1/Merchants

{
  "businessID": 524398752,
  "hierarchyNodeKey": "1234567800000001",
  "dbaName": "Jane's Sandwiches",
  "merchantNumber": "1234567891234567",
  "emailAddress": "jane-doe@sandwiches.com",
  "webSite": "https:/www.janessandwiches.com",
  "phones": [
    {
      "phoneTypeCodeID": 1,
      "areaCode": "415",
      "phoneNumber": "5551234",
      "extension": "101"
    }
  ],
  "acceptsPaperStatements": true,
  "acceptsPaperTaxForms": false,
  "companyTypeId": 2,
  "isChainMerchant": false,
  "seasonalSchedule": {
    "january": true,
    "february": false,
    "march": true,
    "april": true,
    "may": true,
    "june": false,
    "july": true,
    "august": true,
    "september": false,
    "october": true,
    "november": true,
    "december": false
  },
  "salesInformation": {
    "salesInformationID": 1001,
    "businessID": 2002,
    "assignedUser": 3003,
    "referralPartner": "John Doe",
    "compensationType": 2
  }
}

Once validation is complete, the merchant is created, and the changes are queued for processing. This response includes the merchant's details, setting the foundation for adding demographic information by initiating other relevant endpoints in the subdomain.

2. Add Merchant Demographics Information

Business Contact

The ‘Business Contact’ endpoint allows users to establish a primary point of contact for the business and ensures the total ownership adds up to 100%. By using the POST method, this endpoint enables the submission of essential details such as personal information and ownership stakes to the merchant account, ensuring accurate record-keeping of each business contact.

POST https - /api/demographics/v1/BusinessContacts/{merchantNumber}

{
  "phoneNumbers": [
    {
      "phoneTypeCodeID": 1,
      "areaCode": "415",
      "phoneNumber": "5555678",
      "extension": "102"
    }
  ],
  "businessContactId": 1001,
  "contact": {
    "countryOfCitizenshipCode": 840,
    "address": {
      "line1": "456 Market St",
      "line2": "Suite 300",
      "line3": "",
      "city": "San Francisco",
      "countryCode": 840,
      "stateCode": "CA",
      "zip": "94103"
    },
    "ssnLastFour": "6789",
    "encryptedSSN": "ENCRYPTED_VALUE",
    "ssn": "123-45-6789",
    "contactId": 2002,
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1985-07-22T00:00:00.000Z"
  },
  "ownershipAmount": 50,
  "emailAddress": "john.doe@business.com",
  "title": "Managing Partner",
  "contactTypes": [
    {
      "businessContactContactTypeID": 3003,
      "businessContactID": 1001,
      "contactTypeID": 2
    }
  ],
  "isCompassUser": true,
  "isMerchantHomeUser": true,
  "isVirtualTerminalUser": true,
  "isAuthorizedToPurchase": true
}
Physical Address

The ‘Physical Address’ endpoint assigns a physical location to the merchant account, representing the geographic site where the business operates. It uses the POST method to submit location details with specific parameters. This address must be a registered business or retail location.

POST https - /api/demographics/v1/MerchantPhysicalAddresses/{merchantNumber}

{
  "stateCode": "CA",
  "zip": "94103",
  "countryCode": 840,
  "line1": "789 Mission St",
  "line2": "Suite 400",
  "line3": "",
  "city": "San Francisco"
}
Mailing Address

The ‘Mailing Address’ endpoint assigns an address for correspondence and official communications to the merchant account. It uses the POST method to submit address details with specific parameters (similar to Physical Address). A mailing address must be provided even if it matches the physical address.

POST https - /api/demographics/v1/MerchantMailingAddresses/{merchantNumber}

{
  "stateCode": "CA",
  "zip": "94103",
  "countryCode": 840,
  "line1": "789 Mission St",
  "line2": "Suite 400",
  "line3": "",
  "city": "San Francisco"
}
Taxpayer Information

The ‘Taxpayer Information’ endpoint adds essential taxpayer details (necessary for compliance with tax regulations) to the merchant account. It uses the POST method to submit relevant taxpayer data, such as the merchant’s legal name, tax ID, state of incorporation, etc. This information is crucial to ensure proper identification and reporting for the businesses.

POST https - /api/demographics/v2/Taxpayers/{merchantNumber}

{
  "legalFirstName": "John",
  "legalLastName": "Doe",
  "tin": "12-3456789",
  "encryptedTIN": "ENCRYPTED_TIN_VALUE",
  "tinTypeID": 3,
  "businessLegalName": "Doe Enterprises LLC",
  "stateIncorporatedCode": "CA"
}
Banking Information

The ‘Banking Information’ endpoint adds the banking details (for handling merchant transactions) to the merchant account. It uses the POST method to submit information such as deposits, fees, chargebacks, etc. for the specific merchantNumber (16-digit MID).

POST https - /api/demographics/v1/BankAccounts/{merchantNumber}

{
  "bankAccountID": 1001,
  "bankName": "Bank of America",
  "nameOnAccount": "Doe Enterprises LLC",
  "accountHolderFirstName": "John",
  "accountHolderLastName": "Doe",
  "bankAccountTypeID": 3,
  "bankAccountNameTypeID": 1,
  "aba": "091000019",
  "accountNumber": "123456789012",
  "lastFourAccountNumber": "9012",
  "encryptedAccountNumber": "ENCRYPTED_ACCOUNT_VALUE",
  "voidedCheckDocumentID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hasFees": true,
  "hasFunds": true,
  "hasChargebacks": true,
  "isNameSameAsLegalOrDBAName": true,
  "currency": "USD",
  "purpose": "Settlement",
  "lastUpdatedUtc": "2024-10-15T10:18:39.702Z"
}
Sales Profile

The 'Sales Profile' endpoint documents the business model, revenue streams, and sales expectations for the merchant. It adds essential sales processing information, card brand entitlements, and other merchant-specific details that are crucial for the merchant's payment processing setup. Using the POST method, this endpoint outlines the sales activities and product offerings associated with the specific merchant number.

POST https - /api/demographics/v2/SalesProfiles/{merchantNumber}

{
  "usesFulfillmentHouse": true,
  "offersNegativeOptionBilling": false,
  "fulfillmentHouseAddress": {
    "line1": "1011 Northwest Ave",
    "line2": "Suite 223",
    "line3": "",
    "city": "Kansas City",
    "countryCode": 840,
    "stateCode": "MO",
    "zip": "64105"
  },
  "fulfillmentHousePhone": {
    "areaCode": "816",
    "phoneNumber": "5556789",
    "extension": "105",
    "phoneTypeCodeID": 3
  },
  "vendorName": "Doe Distribution Inc.",
  "dateOfIncorporation": "2018-06-15T00:00:00",
  "useExtraCnpValidation": true,
  "isECommerce": true,
  "mccCode": "5812",
  "cardPresentPercentage": 40,
  "returnRefundPolicy": "Full refunds are available within 60 days.",
  "productsSold": "Organic food and beverages.",
  "previouslyAcceptedPaymentCards": true,
  "previousProcessorId": 12,
  "previouslyTerminatedOrIdentifiedByRiskMonitoring": false,
  "reasonPreviouslyTerminatedOrIdentifiedByRisk": "",
  "currentlyOpenForBusiness": true,
  "annualVolume": 750000,
  "averageTicket": 65.50,
  "highTicket": 850,
  "ownsProduct": true,
  "ordersProduct": true,
  "sellsFirearms": false,
  "cbdSalesTypeID": 2,
  "salesProfileCBD": {
    "annualCBDRevenuePercentage": 20,
    "cbdProductInventoryPercentage": 50,
    "salesProfileCBDCategory": 2,
    "cbdCategoryID": 1
  },
  "sellsFirearmAccessories": false,
  "futureDeliveryTypeID": true,
  "otherDeliveryType": "Standard shipping",
  "otherDeliveryTypeInDays": 7,
  "futureDeliveryPercentage": 60,
  "fireArmsLicense": "",
  "cardBrands": [1, 2, 3, 4],
  "ebtNumber": "1998882",
  "amexMID": "1998882"
}
Site Survey

The ‘Site Survey’ endpoint records on-site data for physical validation of the business. It submits information about the Sales Rep or Agent’s acknowledgment of completing due diligence during the site survey. Using the POST method, it captures key verification details such as valid identification, inventory checks, and in-person verification.

POST https - /api/demographics/v1/SiteSurveys/{merchantNumber}

{
  "siteTypeID": 4,
  "otherSiteTypeDescription": "Retail Storefront",
  "siteSurveyConductedInPerson": true,
  "merchantAcquisitionTypeID": 3,
  "validIDVerified": true,
  "inventoryMatchesProductSold": true,
  "inventoryMatchesProductSoldComments": "Inventory check completed; products match business description.",
  "agreementAccepted": true,
  "selfSignUpApplication": false
}
Beneficial Ownership Agreement

The ‘Beneficial Ownership Agreement’ endpoint confirms legal compliance by acknowledging the beneficial ownership details of members with 25% or more ownership. Using the POST method, it captures and submits the ownership information, ensuring that the necessary legal requirements are met. This process helps verify the ownership structure of the business and ensures compliance with regulations.

POST

https - /api/demographics/v1/BusinessContacts/{merchantNumber}/benificialowneragreement

{
  "allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}
Upload Document

The ‘Upload Document’ endpoint allows users to upload required documents for a merchant account using the assigned merchantNumber. Using the POST method, it enables the submission of document files along with their document ID and category, ensuring that all necessary paperwork is properly attached to the merchant’s account for processing.

POST /api/demographics/v1/Documents/{merchantNumber}

"string"

PreviousCompleting the Merchant ApplicationNextConfiguring Merchant Pricing

Last updated 2 months ago

Was this helpful?

For a detailed breakdown of the request and response fields and their descriptions, refer to the reference documentation of API.

Merchant Demographics