--- updatedAt: 2026-06-09T19:14:54.000Z --- Fetch the complete documentation index at: https://hq.docs.netevia.com/llms.txt. Use this file to discover all available pages before exploring further. # Get merchant's business and owner information ## 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 | Parameter | Type | Required | Description | | --------- | --------------- | -------- | ---------------------------------------------- | | id | integer (int32) | Yes | Unique internal ID of the merchant application | *** ### Response **200 OK** #### Top-level response wrapper | Field | Type | Description | | ----------------- | -------------- | --------------------------------------- | | data | TsysParameters | Business and owner information object | | status | string | HTTP status name, e.g. `OK` | | error | string | Error message if failed, otherwise null | | warning | string | Non-fatal warning if any | | validationResults | array | Field-level validation issues if any | | requestId | integer | Internal request tracking ID | *** #### `data` (TsysParameters) | Field | Type | Description | | ----------------------- | ------------------ | ---------------------------------------------------- | | customerServicePhoneNum | string | 10-digit customer service phone number | | federalTaxId | string | 9-digit EIN (may be partially masked with `*`) | | dateOfStartBusiness | string (date-time) | Business start date ISO 8601 | | merchantEmail | string | Business contact email address | | merchantWebsite | string | Business website URL | | multipleLocations | boolean | Whether merchant operates from multiple locations | | numOfLocations | integer | Number of locations when `multipleLocations` is true | | legalAddress | AddressBase | Legal registered address | | dbaAddress | AddressBase | DBA operating address | | primaryOwner | Owner | Primary owner/principal | | secondaryOwner | SecondaryOwner | Second owner (null if not set) | | owner3 | SecondaryOwner | Third owner (null if not set) | | owner4 | SecondaryOwner | Fourth owner (null if not set) | | controllingOfficer1 | ControllingOfficer | First controlling officer (null if not set) | | controllingOfficer2 | ControllingOfficer | Second controlling officer (null if not set) | *** #### `AddressBase` (used for `legalAddress` and `dbaAddress`) | Field | Type | Description | | ---------- | ------------- | ---------------------------------------------------------------- | | name | string | Business name at this address | | address | string | Street address line 1 | | address2 | string | 🆕 Suite, unit, floor, or apartment number (present only if set) | | postalCode | string | ZIP code | | city | string | City | | state | string (enum) | Full US state name — see enum below | | phone | string | Phone number | | fax | string | Fax number (null if not set) | **`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. | Field | Type | Description | | ---------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | | firstName | string | First name (2–25 letters) | | lastName | string | Last name (2–25 letters) | | middleName | string | Middle name (2–25 letters, null if not set) | | dateOfBirth | string (date-time) | Date of birth ISO 8601 | | ssn | string | 9-digit SSN (masked in response for security) | | address | string | Street address, max 40 chars, alphanumeric | | city | string | City, 2–25 chars | | state | string (enum) | Full US state name | | zip | string | ZIP code (`XXXXX` or `XXXXX-XXXX`) | | homePhone | string | Home phone number | | title | string (enum) | `President`, `VPresident`, `Owner`, `Partner`, `Manager`, `Treasurer`, `Secretary`, `ExecDirector` | | ownership | integer | Ownership percentage 0–100 | | email | string | Email address, max 60 chars | | guarantor | boolean | Whether owner is a personal guarantor | | typeOfIssuedID | string (enum) | `USPassport`, `PermanentRegistrationCard`, `DriversLicense`, `USMilitaryCard`, `USCostGuardMerchantMarinerCard`, `USCitizenIdCard` | | idNumber | string | Government-issued ID number (alphanumeric) | | idExpirationDate | string (date-time) | ID expiration date | *** #### `ControllingOfficer` (used for `controllingOfficer1` and `controllingOfficer2`) | Field | Type | Description | | ---------------- | ------------------ | -------------------------------------------------------------------------------------------------- | | firstName | string | First name (2–25 letters) | | lastName | string | Last name (2–25 letters) | | middleName | string | Middle name (2–25 letters, null if not set) | | dateOfBirth | string (date-time) | Date of birth ISO 8601 | | ssn | string | 9-digit SSN (masked in response) | | title | string (enum) | `President`, `VPresident`, `Owner`, `Partner`, `Manager`, `Treasurer`, `Secretary`, `ExecDirector` | | address | string | Street address, max 40 chars, alphanumeric | | city | string | City, 2–25 chars | | state | string (enum) | Full US state name | | zip | string | ZIP code | | homePhone | string | Home phone number | | email | string | 🆕 Email address, max 60 chars (present only if set) | | guarantor | boolean | Whether officer is a personal guarantor | | typeOfIssuedID | string (enum) | Same enum as Owner.typeOfIssuedID | | idNumber | string | Government-issued ID number | | idExpirationDate | string (date-time) | ID expiration date | *** ### Response Example ```json { "data": { "customerServicePhoneNum": "3055550100", "federalTaxId": "834567890", "dateOfStartBusiness": "2015-03-01T00:00:00Z", "merchantEmail": "info@sunsetgrill.com", "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": "maria@sunsetgrill.com", "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": "carlos@sunsetgrill.com", "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 | Code | When it happens | | ---- | ------------------------------------------------------ | | 400 | `id` query parameter is missing or not a valid integer | | 401 | Invalid or missing Basic Auth credentials | | 403 | User does not have permission for this merchant | | 404 | No merchant application found for the given `id` | | 500 | Internal server error | *** ### 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`](./boarding_updatetsysparameters.md) — update business and owner information * [`POST /api/v1/merchant/submit`](./boarding_submittsys.md) — initial merchant submission * [`GET /api/v1/merchant/account`](./boarding_getsalesandbusinessprofile.md) — retrieve sales and business profile * [`GET /api/v1/merchant/info`](./boarding_gettsysmerchant.md) — retrieve core merchant configuration *** ### Example ```bash 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" ```
# OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "v1", "title": "Netevia HQ | API Documentation", "description": "Netevia HQ | API Documentation" }, "paths": { "/api/v1/merchant/parameters": { "get": { "tags": [ "Merchant applications/Merchants data management" ], "summary": "Get merchant's business and owner information", "operationId": "Boarding_GetTsysParameters", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse1_TsysParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse1_TsysParameters" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiResponse1_TsysParameters" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ApiResponse1_TsysParameters" } } } } } } } }, "security": [ { "Basic": [] } ], "servers": [ { "url": "https://hq.staging.netevia.dev" } ], "components": { "securitySchemes": { "Basic": { "type": "http", "description": "Basic HTTP Authentication", "scheme": "basic" } }, "schemas": { "ValidationResult": { "type": "object", "properties": { "memberNames": { "type": "array", "items": { "type": "string" }, "readOnly": true }, "errorMessage": { "type": "string" } } }, "TsysParameters": { "required": [ "customerServicePhoneNum", "federalTaxId", "dateOfStartBusiness", "legalAddress", "dbaAddress", "primaryOwner" ], "type": "object", "properties": { "customerServicePhoneNum": { "maxLength": 10, "minLength": 10, "pattern": "^[^1].*", "type": "string" }, "federalTaxId": { "pattern": "^(\\d|\\*){9}$", "type": "string" }, "dateOfStartBusiness": { "format": "date-time", "type": "string" }, "merchantEmail": { "type": "string" }, "merchantWebsite": { "pattern": "^((https?):\\/\\/)?(([wW]{3}\\.)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,100})((\\/([\\w-]+\\/?)*)?)$", "type": "string" }, "multipleLocations": { "type": "boolean" }, "numOfLocations": { "format": "int32", "type": "integer" }, "legalAddress": { "$ref": "#/components/schemas/AddressBase" }, "dbaAddress": { "$ref": "#/components/schemas/AddressBase" }, "primaryOwner": { "$ref": "#/components/schemas/Owner" }, "secondaryOwner": { "$ref": "#/components/schemas/SecondaryOwner" }, "owner3": { "$ref": "#/components/schemas/SecondaryOwner" }, "owner4": { "$ref": "#/components/schemas/SecondaryOwner" }, "controllingOfficer1": { "$ref": "#/components/schemas/ControllingOfficer" }, "controllingOfficer2": { "$ref": "#/components/schemas/ControllingOfficer" } } }, "AddressBase": { "required": [ "name", "address", "postalCode", "city", "state", "phone" ], "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "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" ], "type": "string" }, "phone": { "pattern": "^[^1].*", "type": "string" }, "fax": { "pattern": "^[^1].*", "type": "string" } } }, "Owner": { "required": [ "firstName", "lastName", "dateOfBirth", "ssn", "address", "city", "state", "zip", "homePhone", "title", "ownership", "email" ], "type": "object", "properties": { "firstName": { "maxLength": 25, "minLength": 2, "pattern": "^\\s*[A-Za-z]+\\s*$", "type": "string" }, "middleName": { "maxLength": 25, "minLength": 2, "pattern": "^\\s*[A-Za-z]+\\s*$", "type": "string" }, "lastName": { "maxLength": 25, "minLength": 2, "pattern": "^\\s*[A-Za-z]+\\s*$", "type": "string" }, "dateOfBirth": { "format": "date-time", "type": "string" }, "ssn": { "pattern": "^(?!000000000|111111111|222222222|333333333|444444444|55555555|666666666|777777777|888888888|999999999|123456789|987654321|012345678|087654321)\\d{9}$", "type": "string" }, "address": { "maxLength": 40, "minLength": 0, "pattern": "^[A-Za-z\\d\\s]+$", "type": "string" }, "city": { "maxLength": 25, "minLength": 2, "type": "string" }, "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" ], "type": "string" }, "zip": { "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, "homePhone": { "pattern": "^[^1].*", "type": "string" }, "title": { "enum": [ "President", "VPresident", "Owner", "Partner", "Manager", "Treasurer", "Secretary", "ExecDirector" ], "type": "string" }, "ownership": { "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "email": { "maxLength": 60, "minLength": 0, "type": "string" }, "guarantor": { "type": "boolean" }, "typeOfIssuedID": { "enum": [ "USPassport", "PermanentRegistrationCard", "DriversLicense", "USMilitaryCard", "USCostGuardMerchantMarinerCard", "USCitizenIdCard" ], "type": "string" }, "idNumber": { "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "idExpirationDate": { "format": "date-time", "type": "string" } } }, "SecondaryOwner": { "required": [ "firstName", "lastName", "dateOfBirth", "ssn", "address", "city", "state", "zip", "homePhone", "title", "ownership", "email" ], "type": "object", "properties": { "firstName": { "maxLength": 25, "minLength": 2, "pattern": "^\\s*[A-Za-z]+\\s*$", "type": "string" }, "middleName": { "maxLength": 25, "minLength": 2, "pattern": "^\\s*[A-Za-z]+\\s*$", "type": "string" }, "lastName": { "maxLength": 25, "minLength": 2, "pattern": "^\\s*[A-Za-z]+\\s*$", "type": "string" }, "dateOfBirth": { "format": "date-time", "type": "string" }, "ssn": { "pattern": "^(?!000000000|111111111|222222222|333333333|444444444|55555555|666666666|777777777|888888888|999999999|123456789|987654321|012345678|087654321)\\d{9}$", "type": "string" }, "address": { "maxLength": 40, "minLength": 0, "pattern": "^[A-Za-z\\d\\s]+$", "type": "string" }, "city": { "maxLength": 25, "minLength": 2, "type": "string" }, "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" ], "type": "string" }, "zip": { "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, "homePhone": { "pattern": "^[^1].*", "type": "string" }, "title": { "enum": [ "President", "VPresident", "Owner", "Partner", "Manager", "Treasurer", "Secretary", "ExecDirector" ], "type": "string" }, "ownership": { "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "email": { "maxLength": 60, "minLength": 0, "type": "string" }, "guarantor": { "type": "boolean" }, "typeOfIssuedID": { "enum": [ "USPassport", "PermanentRegistrationCard", "DriversLicense", "USMilitaryCard", "USCostGuardMerchantMarinerCard", "USCitizenIdCard" ], "type": "string" }, "idNumber": { "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "idExpirationDate": { "format": "date-time", "type": "string" } } }, "ControllingOfficer": { "required": [ "dateOfBirth", "ssn", "firstName", "lastName", "title", "address", "zip", "city", "state", "homePhone" ], "type": "object", "properties": { "dateOfBirth": { "format": "date-time", "type": "string" }, "ssn": { "pattern": "^(?!000000000|111111111|222222222|333333333|444444444|55555555|666666666|777777777|888888888|999999999|123456789|987654321|012345678|087654321)\\d{9}$", "type": "string" }, "firstName": { "maxLength": 25, "minLength": 2, "pattern": "^\\s*[A-Za-z]+\\s*$", "type": "string" }, "middleName": { "maxLength": 25, "minLength": 2, "pattern": "^\\s*[A-Za-z]+\\s*$", "type": "string" }, "lastName": { "maxLength": 25, "minLength": 2, "pattern": "^\\s*[A-Za-z]+\\s*$", "type": "string" }, "title": { "enum": [ "President", "VPresident", "Owner", "Partner", "Manager", "Treasurer", "Secretary", "ExecDirector" ], "type": "string" }, "address": { "maxLength": 40, "minLength": 0, "pattern": "^[A-Za-z\\d\\s]+$", "type": "string" }, "zip": { "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, "city": { "maxLength": 25, "minLength": 2, "type": "string" }, "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" ], "type": "string" }, "homePhone": { "pattern": "^[^1].*", "type": "string" }, "typeOfIssuedID": { "enum": [ "USPassport", "PermanentRegistrationCard", "DriversLicense", "USMilitaryCard", "USCostGuardMerchantMarinerCard", "USCitizenIdCard" ], "type": "string" }, "idNumber": { "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "idExpirationDate": { "format": "date-time", "type": "string" }, "guarantor": { "type": "boolean" }, "email": { "maxLength": 60, "minLength": 0, "type": "string" } } }, "ApiResponse1_TsysParameters": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TsysParameters" }, "status": { "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "Ambiguous", "MovedPermanently", "Moved", "Found", "Redirect", "SeeOther", "RedirectMethod", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "RedirectKeepVerb", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ], "type": "string" }, "error": { "type": "string" }, "warning": { "type": "string" }, "validationResults": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationResult" } }, "requestId": { "format": "int32", "type": "integer" } } } } } } ```