Update merchant's business and owner information

Time	Status	User Agent
Retrieving recent requests…

Update Merchant Business and Owner Information

Updates the business and owner information for an existing merchant application. Covers customer service contact details, federal tax ID, business start date, legal and DBA addresses, and KYC details for up to four owners and two controlling officers.

Endpoint

POST /api/v1/merchant/parameters

Authentication

Basic HTTP Authentication required.

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint when business contact information, owner details, or address data needs to be corrected or updated after the initial merchant submission. Underwriters frequently request corrections to owner SSNs, date of birth, or address information.

⚠️
All required sub-fields of parameters must be provided whenever the parameters object is included — partial updates are not supported.

Request Body

Top-level structure

Field	Type	Required	Description
id	integer (int32)	Yes	Merchant profile ID to update (1–999999)
parameters	TsysParameters	No	Business and owner parameters to update

`parameters` (TsysParameters)

Field	Type	Required	Description
customerServicePhoneNum	string	Yes	10-digit phone, must not start with 1
federalTaxId	string	Yes	9-char EIN — digits or `*` for masking (`^\d{9}$` or `^(\d	*)9$`)
dateOfStartBusiness	string (date-time)	Yes	Business start date ISO 8601
merchantEmail	string	No	Business contact email address
merchantWebsite	string	No	Business website URL
multipleLocations	boolean	No	Whether merchant has multiple locations
numOfLocations	integer	No	Number of locations if `multipleLocations` is true
legalAddress	AddressBase	Yes	Legal registered address
dbaAddress	AddressBase	Yes	DBA operating address
primaryOwner	Owner	Yes	Primary owner KYC details
secondaryOwner	SecondaryOwner	No	Second owner
owner3	SecondaryOwner	No	Third owner
owner4	SecondaryOwner	No	Fourth owner
controllingOfficer1	ControllingOfficer	No	Controlling officer 1
controllingOfficer2	ControllingOfficer	No	Controlling officer 2

`AddressBase` (used for `legalAddress` and `dbaAddress`)

Field	Type	Required	Description
name	string	Yes	Business name at this address
address	string	Yes	Street address line 1
address2	string	No	🆕 Suite, unit, floor, or apartment number
postalCode	string	Yes	ZIP code
city	string	Yes	City
state	string (enum)	Yes	Full US state name — see enum below
phone	string	Yes	Phone number, must not start with 1
fax	string	No	Fax number

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	Required	Description
firstName	string	Yes	2–25 letters only
lastName	string	Yes	2–25 letters only
middleName	string	No	2–25 letters only
dateOfBirth	string (date-time)	Yes	Date of birth ISO 8601
ssn	string	Yes	9-digit SSN — no sequential or repeated patterns
address	string	Yes	Street address, max 40 chars, alphanumeric only
city	string	Yes	2–25 chars
state	string (enum)	Yes	Full US state name
zip	string	Yes	`XXXXX` or `XXXXX-XXXX` format
homePhone	string	Yes	Must not start with 1
title	string (enum)	Yes	`President`, `VPresident`, `Owner`, `Partner`, `Manager`, `Treasurer`, `Secretary`, `ExecDirector`
ownership	integer	Yes	Ownership percentage 0–100
email	string	Yes	Max 60 chars
guarantor	boolean	No	Whether owner is a personal guarantor
typeOfIssuedID	string (enum)	No	`USPassport`, `PermanentRegistrationCard`, `DriversLicense`, `USMilitaryCard`, `USCostGuardMerchantMarinerCard`, `USCitizenIdCard`
idNumber	string	No	Alphanumeric ID document number
idExpirationDate	string (date-time)	No	ID expiration date ISO 8601

`ControllingOfficer` (used for `controllingOfficer1` and `controllingOfficer2`)

Field	Type	Required	Description
firstName	string	Yes	2–25 letters only
lastName	string	Yes	2–25 letters only
middleName	string	No	2–25 letters only
dateOfBirth	string (date-time)	Yes	Date of birth ISO 8601
ssn	string	Yes	9-digit SSN — no sequential or repeated patterns
title	string (enum)	Yes	`President`, `VPresident`, `Owner`, `Partner`, `Manager`, `Treasurer`, `Secretary`, `ExecDirector`
address	string	Yes	Max 40 chars, alphanumeric only
city	string	Yes	2–25 chars
state	string (enum)	Yes	Full US state name
zip	string	Yes	ZIP code (`XXXXX` or `XXXXX-XXXX`)
homePhone	string	Yes	Must not start with 1
email	string	No	🆕 Max 60 chars
guarantor	boolean	No	Whether officer is a personal guarantor
typeOfIssuedID	string (enum)	No	Same enum as Owner.typeOfIssuedID
idNumber	string	No	Alphanumeric ID document number
idExpirationDate	string (date-time)	No	ID expiration date ISO 8601

Request Example

{
  "id": 10482,
  "parameters": {
    "customerServicePhoneNum": "8005551234",
    "federalTaxId": "123456789",
    "dateOfStartBusiness": "2018-03-15T00:00:00Z",
    "merchantEmail": "[email protected]",
    "merchantWebsite": "https://greentreecafe.com",
    "multipleLocations": false,
    "legalAddress": {
      "name": "Green Tree Cafe LLC",
      "address": "450 Main St",
      "address2": "Suite 100",
      "postalCode": "30301",
      "city": "Atlanta",
      "state": "Georgia",
      "phone": "4045557890"
    },
    "dbaAddress": {
      "name": "Green Tree Cafe",
      "address": "450 Main St",
      "address2": "Suite 100",
      "postalCode": "30301",
      "city": "Atlanta",
      "state": "Georgia",
      "phone": "4045557890"
    },
    "primaryOwner": {
      "firstName": "Marcus",
      "lastName": "Jordan",
      "dateOfBirth": "1978-06-21T00:00:00Z",
      "ssn": "500123456",
      "address": "112 Peachtree Ln",
      "city": "Atlanta",
      "state": "Georgia",
      "zip": "30302",
      "homePhone": "4045559876",
      "title": "Owner",
      "ownership": 100,
      "email": "[email protected]",
      "guarantor": true,
      "typeOfIssuedID": "DriversLicense",
      "idNumber": "GA123456789",
      "idExpirationDate": "2028-06-21T00:00:00Z"
    },
    "controllingOfficer1": {
      "firstName": "Sarah",
      "lastName": "Jordan",
      "dateOfBirth": "1980-04-10T00:00:00Z",
      "ssn": "500987654",
      "title": "President",
      "address": "112 Peachtree Ln",
      "city": "Atlanta",
      "state": "Georgia",
      "zip": "30302",
      "homePhone": "4045559877",
      "email": "[email protected]"
    }
  }
}

Response

200 OK

Field	Type	Description
data	object	Empty object on success
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 errors — each has `memberNames` (array) and `errorMessage` (string)
requestId	integer	Internal request tracking ID

{
  "data": {},
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 71205
}

Error Codes

Code	When it happens
400	`id` missing; required `parameters` sub-fields absent; SSN/phone/ZIP validation failed — check `validationResults`
401	Invalid or missing Basic Auth credentials
403	No permission to update this merchant application
404	No merchant application found with the given `id`
500	Internal server error

Common Mistakes

Partial updates not supported — all required fields within parameters must be present even when updating just one field (e.g. address).
customerServicePhoneNum must be exactly 10 digits — no spaces, dashes, or parentheses, must not start with 1.
federalTaxId must be exactly 9 characters — digits only or * for masking. No dashes (47-1234567 is invalid).
ssn must be 9 digits and cannot be sequential (123456789), repeated (111111111), or other blocked patterns.
firstName and lastName must contain only letters — no spaces within names, no hyphens.
zip must match XXXXX or XXXXX-XXXX — use hyphen format for 9-digit ZIPs.
state must be the full enum value — Georgia not GA or "Georgia".
address2 is optional and backward compatible — omitting it does not affect existing integrations.
Controlling officer email is optional — omitting it will not clear a previously stored value unless you explicitly send null.
All owners with 20%+ ownership must be listed in the appropriate owner slot.

Related Endpoints

GET /api/v1/merchant/parameters — read current parameters before updating
POST /api/v1/merchant/submit — initial merchant submission
POST /api/v1/merchant/account — update sales and business profile
POST /api/v1/merchant/siteInspection — update site inspection details
GET /api/v1/merchant/status — check application status

Example

curl -X POST https://hq.staging.netevia.dev/api/v1/merchant/parameters \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 10482,
    "parameters": {
      "customerServicePhoneNum": "8005551234",
      "federalTaxId": "123456789",
      "dateOfStartBusiness": "2018-03-15T00:00:00Z",
      "legalAddress": {
        "name": "Green Tree Cafe LLC",
        "address": "450 Main St",
        "address2": "Suite 100",
        "postalCode": "30301",
        "city": "Atlanta",
        "state": "Georgia",
        "phone": "4045557890"
      },
      "dbaAddress": {
        "name": "Green Tree Cafe",
        "address": "450 Main St",
        "postalCode": "30301",
        "city": "Atlanta",
        "state": "Georgia",
        "phone": "4045557890"
      },
      "primaryOwner": {
        "firstName": "Marcus",
        "lastName": "Jordan",
        "dateOfBirth": "1978-06-21T00:00:00Z",
        "ssn": "500123456",
        "address": "112 Peachtree Ln",
        "city": "Atlanta",
        "state": "Georgia",
        "zip": "30302",
        "homePhone": "4045559876",
        "title": "Owner",
        "ownership": 100,
        "email": "[email protected]"
      }
    }
  }'

Update Merchant Business and Owner Information

Endpoint

Authentication

When to use

All required sub-fields of parameters must be provided whenever the parameters object is included — partial updates are not supported.

Request Body

Top-level structure

parameters (TsysParameters)

AddressBase (used for legalAddress and dbaAddress)

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

ControllingOfficer (used for controllingOfficer1 and controllingOfficer2)

Request Example

Response

Error Codes

Common Mistakes

Related Endpoints

Example

200OK

All required sub-fields of `parameters` must be provided whenever the `parameters` object is included — partial updates are not supported.

`parameters` (TsysParameters)

`AddressBase` (used for `legalAddress` and `dbaAddress`)

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

`ControllingOfficer` (used for `controllingOfficer1` and `controllingOfficer2`)