Get Merchant Business and Owner Information

Retrieves the complete business and ownership profile for a merchant application. The response includes business contact details, legal and DBA addresses, primary owner KYC information, up to three additional owners, and up to two controlling officers. This data is required for KYC compliance and underwriting review.

Endpoint

GET /api/v1/merchant/parameters

Authentication

Basic HTTP Authentication required.

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint to read back the business and owner data stored for a merchant application — typically when displaying the "Business & Owner Information" section for review or editing. Underwriters also use this to verify identities and ownership structure before making a decision.

Query Parameters

Response

200 OK

Top-level response wrapper

data (TsysParameters)

AddressBase (used for legalAddress and dbaAddress)

state enum: Alaska, Alabama, Arkansas, Arizona, California, Colorado, Connecticut, DistrictOfColumbia, Delaware, Florida, Georgia, Hawaii, Iowa, Idaho, Illinois, Indiana, Kansas, Kentucky, Louisiana, Massachusetts, Maryland, Maine, Michigan, Minnesota, Missouri, Mississippi, Montana, NorthCarolina, NorthDakota, Nebraska, NewHampshire, NewJersey, NewMexico, Nevada, NewYork, Ohio, Oklahoma, Oregon, Pennsylvania, PuertoRico, RhodeIsland, SouthCarolina, SouthDakota, Tennessee, Texas, Utah, Virginia, VirginIslands, Vermont, Washington, Wisconsin, WestVirginia, Wyoming

Owner (used for primaryOwner) / SecondaryOwner (used for secondaryOwner, owner3, owner4)

Both schemas are identical in structure.

ControllingOfficer (used for controllingOfficer1 and controllingOfficer2)

Response Example

{
  "data": {
    "customerServicePhoneNum": "3055550100",
    "federalTaxId": "834567890",
    "dateOfStartBusiness": "2015-03-01T00:00:00Z",
    "merchantEmail": "[email protected]",
    "merchantWebsite": "https://www.sunsetgrill.com",
    "multipleLocations": false,
    "numOfLocations": 1,
    "legalAddress": {
      "name": "Sunset Grill LLC",
      "address": "123 Ocean Drive",
      "address2": "Suite 200",
      "postalCode": "33139",
      "city": "Miami Beach",
      "state": "Florida",
      "phone": "3055550100",
      "fax": null
    },
    "dbaAddress": {
      "name": "Sunset Grill",
      "address": "123 Ocean Drive",
      "address2": "Suite 200",
      "postalCode": "33139",
      "city": "Miami Beach",
      "state": "Florida",
      "phone": "3055550100",
      "fax": null
    },
    "primaryOwner": {
      "firstName": "Maria",
      "lastName": "Gonzalez",
      "middleName": null,
      "dateOfBirth": "1978-06-15T00:00:00Z",
      "ssn": "XXXXX2345",
      "address": "456 Palm Ave",
      "city": "Miami",
      "state": "Florida",
      "zip": "33101",
      "homePhone": "3055550200",
      "title": "Owner",
      "ownership": 100,
      "email": "[email protected]",
      "guarantor": true,
      "typeOfIssuedID": "DriversLicense",
      "idNumber": "G123456780",
      "idExpirationDate": "2028-01-01T00:00:00Z"
    },
    "secondaryOwner": null,
    "owner3": null,
    "owner4": null,
    "controllingOfficer1": {
      "firstName": "Carlos",
      "lastName": "Gonzalez",
      "middleName": null,
      "dateOfBirth": "1975-11-20T00:00:00Z",
      "ssn": "XXXXX9876",
      "title": "President",
      "address": "456 Palm Ave",
      "city": "Miami",
      "state": "Florida",
      "zip": "33101",
      "homePhone": "3055550201",
      "email": "[email protected]",
      "guarantor": false,
      "typeOfIssuedID": "USPassport",
      "idNumber": "US123456789",
      "idExpirationDate": "2030-06-01T00:00:00Z"
    },
    "controllingOfficer2": null
  },
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 120455
}

Error Codes

Common Mistakes

• address2 will only appear in the response if a value was previously submitted — it will not be present as null if never set.
• email for controlling officers will only appear if a value was set — check for field existence before accessing.
• state is a full spelled-out enum value — Florida not FL or "Florida".
• SSN values in the response are masked for security — do not rely on them for verification.
• All owners with 20% or more ownership must be listed — regulators require disclosure of all significant owners.
• Do not use test SSNs such as 123456789 or 000000000 — these are explicitly blocked by validation.

Related Endpoints

• POST /api/v1/merchant/parameters — update business and owner information
• POST /api/v1/merchant/submit — initial merchant submission
• GET /api/v1/merchant/account — retrieve sales and business profile
• GET /api/v1/merchant/info — retrieve core merchant configuration

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/parameters?id=10045" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Accept: application/json"