---
updatedAt: 2026-09-11T20:23:52.000Z
agentTools:
projectIndex: https://docs.staxpayments.com/llms.txt
---
# Update Merchant Registration Data
Upserts registration data for a merchant, used during onboarding.
## Overview
This endpoint allows you to upsert merchant registration data during the onboarding process, providing comprehensive support for merchant verification, compliance, and self-registration workflows.
Collect principal signer, business, and beneficial owner information
Automatically verify merchant information and identify required documents
Meet federal requirements for beneficial ownership disclosure
## Key Features
Data provided at the root of the request body (e.g., `first_name`, `business_name`) pertains to the Principal Signer/Control Owner or the business itself.
### Additional Representatives/Beneficial Owners
* If there are Additional Representatives or Beneficial Owners, include their information in the `meta.representatives` array.
* Each representative should be provided as an object containing their details.
This field should contain the HTML content of the terms and conditions.
**Implementation Steps:**
1. Retrieve the terms and conditions using the **Retrieve Terms and Conditions** endpoint
2. Include this content to capture the merchant's agreement to the terms during the enrollment process
Determines whether to run automatic verifications on the registration information. Verifications help confirm the accuracy of the merchant's information and identify any additional documents required.
### Types of Verifications
**Person Identification and SSN Verification:**
* Run on the principal and any beneficial owners
* Validates personal information against external databases
**Business Identification and Banking Verification:**
* Run on the business information
* Ensures that the business is legitimate and that banking details are correct
> **Note:** If a verification fails, the relevant registration documents will be enabled.
As of May 11, 2018, you must provide information on Control Owners and Beneficial Owners (individuals owning 25% or more of the entity).
### Requirements
* Provide information on any additional representatives if any individuals directly or indirectly own 25% or more of the entity
* Ensure that all necessary personal and ownership details are included for compliance
Control the visibility and editability of fields during the self-registration process, particularly when using Stax's hosted Signup Pages.
### Automatic Field Hiding
Set `hide_prefilled_fields: true` in your payload to automatically hide any fields that are prefilled via the API. This streamlines the registration process by only displaying fields that require the merchant's input.
### Manual Field Control
Use the `field_permissions` object within the `registration` parameter to manually set permissions for specific fields.
### Field Permission Options
* `null`: Field will be hidden
* `read`: Field will be read-only
* `write`: Field will be writable (default behavior)
**Behavior Notes:**
* If all fields in a given section are hidden, the entire section or page will be hidden from the front-end user interface
* If all fields for a given page have been prefilled and hidden, the page will be removed from the sidebar tracker in the self-registration application
* Hidden fields with values passed in will not be visible on the review step
## Important Considerations
### Data Accuracy
* Ensure all provided information is accurate to prevent delays in the underwriting process
* Inaccurate or incomplete data may lead to failed auto-verifications and additional document requirements
### Compliance Requirements
* Be thorough in collecting information on all required representatives to meet federal regulations
* Missing information on beneficial owners can result in application rejections
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "stax-api",
"version": "0.1"
},
"servers": [
{
"url": "https://apiprod.fattlabs.com/"
}
],
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant account settings. This key is scoped to a single merchant account and cannot access partner-level functionality."
},
"PartnerApiKey": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Partner-level API key with elevated privileges. Grants access to all partner operations including merchant management, portfolio oversight, reporting across multiple merchant accounts, and partner-specific administrative functions. Also provides access to all merchant-level operations for accounts under the partner's management."
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"paths": {
"/merchant/{id}/registration": {
"put": {
"summary": "Update Merchant Registration Data",
"description": "Upserts registration data for a merchant, used during onboarding.",
"operationId": "update-merchant-registration-data",
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string"
},
"required": true,
"description": "ID of the merchant"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "100 character max. Merchant email address."
},
"first_name": {
"type": "string",
"description": "Merchant owner/signer first name. 100 character max."
},
"last_name": {
"type": "string",
"description": "Merchant owner/signer last name. 100 character max."
},
"refund_policy": {
"type": "string",
"enum": [
"'N'",
"'E'",
"'T'",
"'O'"
],
"description": "Refund policy. N: No Refunds, E: Merchandise Exchange Only, T: 30 Days or Fewer, O: Other"
},
"business_fax": {
"type": "string",
"description": "Merchant fax number. format: (999) 999-9999, 9999999999, 999-999-9999."
},
"business_legal_name": {
"type": "string",
"description": "Merchant business legal name. 100 character max."
},
"business_dba": {
"type": "string",
"description": "Merchant business 'Doing Business As' name (should be same as legal name if no dba)."
},
"business_website": {
"type": "string",
"description": "merchant business website address (include http://). 100 characters max."
},
"business_phone_number": {
"type": "string",
"description": "Merchant business phone number, format: (999) 999-9999, 9999999999, 999-999-9999."
},
"business_address_1": {
"type": "string",
"description": "Merchant business address line 1.100 characters max."
},
"business_address_2": {
"type": "string",
"description": "merchant business address line 2 (optional if no address line 2). 100 characters max."
},
"business_address_city": {
"type": "string",
"description": "Merchant business city."
},
"business_address_state": {
"type": "string",
"description": "The two letter abbreviation of the state."
},
"business_address_zip": {
"type": "string",
"description": "Merchant business zip"
},
"business_address_country": {
"type": "string",
"description": "Merchant business country 2 characters."
},
"business_location_address_1": {
"type": "string",
"description": "Merchant business address line 1 (if no secondary billing address, this field should be a duplicate of business_address_1)"
},
"business_location_address_2": {
"type": "string",
"description": "Merchant business address line 2 (if no secondary billing address, this field should be a duplicate of business_address_2)"
},
"business_location_address_city": {
"type": "string",
"description": "Merchant business city (if no secondary billing address, this field should be a duplicate of business_address_city)"
},
"business_location_address_state": {
"type": "string",
"description": "Merchant business state two letters (if no secondary billing address, this field should be a duplicate of business_address_state)"
},
"business_location_address_zip": {
"type": "string",
"description": "Merchant business zip (if no secondary billing address, this field should be a duplicate of business_address_zip)."
},
"business_location_address_country": {
"type": "string",
"description": "Merchant business country iso alpha-2(if no secondary billing address, this field should be a duplicate of business_address_country)."
},
"business_location_phone_number": {
"type": "string",
"description": "Merchant business phone number, format: (999) 999-9999 (if no secondary billing address, this field should be a duplicate of business_address_phone)."
},
"business_open_date": {
"type": "string",
"description": "Merchant business open date. Format MM/DD/YYYY."
},
"company_type": {
"type": "string",
"enum": [
"A",
"G",
"S",
"F",
"L",
"E",
"P",
"V",
"B",
"R"
],
"description": "A: Association/Estate/Trust, G: Government (Federal/State/Local), S: Individual/Sole Proprietor, F: Financial Institution, L: LLC (Limited-Liability Corporation), E: Tax-Exempt Organization (501C), P: Partnership, V: Private Corporation, B: Public Corporation, R: SEC-Registered Entity."
},
"business_tax_id": {
"type": "string",
"description": "Merchant business tax id. Format: 12-3456789."
},
"annual_volume": {
"type": "string",
"description": "Merchant's annual credit card only volume."
},
"annual_gross_ach_revenue": {
"type": "string",
"description": "Merchant's annual ACH volume. Can be null."
},
"avg_trans_size": {
"type": "string",
"description": "Merchant's credit card average transaction size."
},
"avg_ach_transaction": {
"type": "string",
"description": "Merchant's average ACH transaction size. Can be null."
},
"highest_trans_amount": {
"type": "string",
"description": "Merchant's reported highest credit card transaction amount."
},
"largest_ach_transaction": {
"type": "string",
"description": "Merchant's reported highest ACH transaction amount. Can be null."
},
"card_present_percent": {
"type": "string",
"description": "Merchant volume card present percent eg: 50 (ex. Terminal transactions where card is physically present at time of transaction)"
},
"card_swiped_percent": {
"type": "string",
"description": "Merchant volume of card swiped transactions. percent eg 50. Can be null."
},
"card_not_present_percent": {
"type": "string",
"description": "Merchant volume not present, e.g., 15 (e.g., transactions taken on the website where the user enters card information into a form)."
},
"moto_percent": {
"type": "string",
"description": "Merchant volume percentage taken over moto (mail order telephone order) -- typically the same value as card_not_present_percent."
},
"internet": {
"type": "string",
"description": "Merchant volume percentage taken over the internet."
},
"b2b_percent": {
"type": "string",
"description": "The merchant business to business volume percentage"
},
"international": {
"type": "string",
"description": "The merchant international volume percentage."
},
"bank_routing_number": {
"type": "string",
"description": "The billing bank routing number."
},
"bank_account_number": {
"type": "string",
"description": "The billing bank account number."
},
"bank_account_owner_name": {
"type": "string",
"description": "The billing bank account owner name."
},
"pricing_plan": {
"type": "string",
"description": "IMPORTANT: Partners only. Please reach out to your account manager or POC for information on your pricing plan option(s)."
},
"proc_change": {
"type": "string",
"enum": [
"PROC_CHANGE",
"NOT_NOW_PROC"
],
"description": " Has merchant processed before or are they not currently processing. PROC_CHANGE: merchant is currently processing with a different processor and needs to change processors. NOT_NOW_PROC: merchant is not currently processing payments"
},
"mcc": {
"type": "string",
"description": "IMPORTANT: Partners only. Please reach out to your account manager or POC for information on mcc codes if needed."
},
"service_you_provide": {
"type": "string",
"description": "The merchant business main service/ product description. Max 200 characters."
},
"bus_type": {
"type": "string",
"description": "Business type: 1: Retail, 11: Restaurant, 12: Moto, 18: Internet",
"enum": [
"1",
"11",
"12",
"18"
]
},
"sub_bus_type": {
"type": "string",
"description": "Sub business type: 19: Retail.key entered, 45: Moto, 13: Dial pay capture, 36: Interchange plus",
"enum": [
"19",
"45",
"13",
"36"
]
},
"principal_owners_name": {
"type": "string",
"description": "The merchant owner principal first and last name."
},
"job_title": {
"type": "string",
"description": "The merchant owner title (same as title)."
},
"title": {
"type": "string",
"description": "The merchant owner title (same as job_title)."
},
"user_dob": {
"type": "string",
"description": "Owner date of birth. Format: MM/DD/YYYY"
},
"drivers_license_id": {
"type": "string",
"description": "Driver's license id of the owner/signer. Can be null."
},
"drivers_license_state": {
"type": "string",
"description": "The state where driver's license of the owner/signer was issued (Please send in a 2-character state code. ex. \"FL\" for Florida). Can be null."
},
"phone_number": {
"type": "string",
"description": "Owner/signer phone number, format: (999) 999-9999."
},
"owner_address_1": {
"type": "string"
},
"owner_address_2": {
"type": "string"
},
"owner_address_city": {
"type": "string"
},
"owner_address_state": {
"type": "string",
"description": "Owner/signer's 2-character state."
},
"owner_address_country": {
"type": "string",
"description": "Owner/signer's 2 character state."
},
"owner_address_zip": {
"type": "string",
"description": "Postal / Zip code."
},
"user_ssn": {
"type": "string",
"description": "Primary owner/signer social security number."
},
"note": {
"type": "string",
"description": "max 100 characters."
},
"electronic_signature": {
"properties": {
"html_content": {
"type": "string",
"description": " Legal content displayed to user (talk to your Partner Success Team for more information)."
},
"ip": {
"type": "string",
"description": "ipv4, ipv6"
},
"user_id": {
"type": "string",
"description": "User_id or user email associated with the merchant."
},
"email": {
"type": "string",
"description": "User email associated with the merchant."
},
"browser_agent": {
"type": "string",
"description": "\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36\"."
}
},
"required": [],
"type": "object"
},
"credit_inquiry_electronic_signature": {
"properties": {
"html_content": {
"type": "string",
"description": "legal content displayed to user which allows Stax to perform soft credit pulls. The credit inquiry must be agreed to independent of the payment processing agreement or any other terms in your application. We recommend having a separate checkbox for the credit inquiry before submitting the application (talk to your Partner Success Team for more information)\"You understand that by clicking on the checkbox associated with this notice, you are providing ‘written instructions’ to Stax and any lender to whom Stax forwards this application, in connection with this application, for commercial lending under the Fair Credit Reporting Act, hereby authorizing Stax and any such lender to obtain information from your personal credit report or other information from Experian. You authorize Stax and any such lender to obtain such information solely in connection with this application for commercial lending.\""
},
"ip": {
"type": "string",
"description": " ipv4, ipv6"
},
"user_id": {
"type": "string",
"description": "User ID or user email associated with the merchant."
},
"email": {
"type": "string",
"description": "User email associated with the merchant."
},
"browser_agent": {
"type": "string",
"description": "e.g. \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36\"."
}
},
"required": [],
"type": "object"
},
"meta": {
"properties": {
"owner_percentage": {
"type": "string",
"description": "The ownership percentage for primary owner, eg. 50"
},
"owner_citizenship": {
"type": "string",
"description": "The ownership 3 character ISO country code for primary owner eg ALA."
},
"representatives": {
"properties": {
"title": {
"type": "string",
"description": "Position within the organization."
},
"date_of_birth": {
"type": "string",
"description": "DOB format: MM/DD/YYYY"
},
"ssn": {
"type": "string",
"description": "Representative social security number."
},
"drivers_license_id": {
"type": "string",
"description": "Driver's license id of the representative. Can be NULL."
},
"drivers_license_state": {
"type": "string",
"description": "The state where driver's license was issued (Please send in a 2-character state code. ex. \"FL\" for Florida)."
},
"first_name": {
"type": "string",
"description": "Name of representative."
},
"last_name": {
"type": "string",
"description": "Surname of representative."
},
"type": {
"type": "string",
"description": "Type of owner.",
"enum": [
"Beneficial Owner",
"Guarantor"
]
},
"ownership_percentage": {
"type": "string",
"description": "Ownership percentage for company representatives, eg. 50"
},
"email": {
"type": "string",
"description": "Representative email."
},
"phone": {
"type": "string",
"description": "Representative phone number."
},
"address_1": {
"type": "string"
},
"address_2": {
"type": "string"
},
"address_city": {
"type": "string"
},
"address_state": {
"type": "string",
"description": "State (two letter) (ex. FL)."
},
"address_zip": {
"type": "string"
},
"citizenship": {
"type": "string",
"description": "3 character ISO country code for company representative, eg. ALA."
}
},
"required": [],
"type": "object",
"description": "Any additional representatives (required for any owner/representative with 25% or more ownership)."
},
"{partnername}_created_at": {
"type": "string",
"description": "The created at date with the ISV software. Format YYYY-MM-DD."
},
"{partnername}_netnew": {
"type": "boolean",
"description": " Indicates if the merchant is a brand new merchant for the ISV. "
},
"{partnername}_months_processing": {
"type": "string",
"description": "Indicates the amount of months the merchant has processed payments with another payment solution in the ISV. If none, indicate \"0\""
}
},
"required": [],
"type": "object"
},
"files": {
"type": "string",
"description": "See Add File To Merchant Registration route for more information."
},
"autoverify": {
"type": "boolean",
"description": "Determines whether or not to run autoverification on the registration record. See \"Get Registration Documents\" for more info on autoverification."
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"annual_volume\": \"\",\n \"avg_trans_size\": \"\",\n \"b2b_percent\": \"\",\n \"bank_account_type\": \"\",\n \"business_address_1\": \"\",\n \"business_address_2\": \"\",\n \"business_address_city\": \"\",\n \"business_address_country\": \"\",\n \"business_address_state\": \"\",\n \"business_address_zip\": \"\",\n \"business_dba\": \"\",\n \"business_email\": \"\",\n \"business_fax\": \"\",\n \"business_legal_name\": \"\",\n \"business_open_date\": \"\",\n \"business_phone_number\": \"\",\n \"business_tax_id\": \"\",\n \"business_website\": \"\",\n \"card_not_present_percent\": \"\",\n \"card_present_percent\": \"\",\n \"card_swiped_percent\": \"\",\n \"chosen_plan\": \"\",\n \"chosen_processing_method\": \"\",\n \"company_type\": \"\",\n \"drivers_license_id\": \"M9K778578\",\n \"drivers_license_state\": \"FL\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"highest_trans_amount\": \"\",\n \"international\": \"\",\n \"internet\": \"\",\n \"job_title\": \"\",\n \"last_name\": \"\",\n \"location_type\": \"\",\n \"mcc\": \"1750\",\n \"meta\": {\n \"ownership_percentage\": 60,\n \"owner_citizenship\": \"ALA\",\n \"representatives\": [\n {\n \"title\": \"\",\n \"date_of_birth\": \"\",\n \"ssn\": \"\",\n \"drivers_license_id\": \"M9K778578\",\n \"drivers_license_state\": \"FL\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"type\": \"\",\n \"ownership_percentage\": 40,\n \"email\": \"\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"citizenship\": \"ALA\"\n }\n ],\n \"stax_created_at\": \"2022-06-30\",\n \"stax_netnew\": true,\n \"stax_months_processing\": \"0\"\n },\n \"moto_percent\": \"\",\n \"network\": \"\",\n \"owner_address_1\": \"\",\n \"owner_address_2\": \"\",\n \"owner_address_city\": \"\",\n \"owner_address_country\": \"\",\n \"owner_address_state\": \"\",\n \"owner_address_zip\": \"\",\n \"phone_number\": \"\",\n \"plan\": \"\",\n \"pricing_plan\": \"interchange0-15\",\n \"principal_owners_name\": \"\",\n \"reason_for_applying\": \"\",\n \"referred_by\": \"\",\n \"refund_policy\": \"\",\n \"seasonal_flag\": false,\n \"seasonal_months\": \"\",\n \"service_you_provide\": \"\",\n \"title\": \"\",\n \"user_dob\": \"\",\n \"merchant_id\": \"791fc3fa-4534-4617-97b6-d41c9e1ce8da\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"updated_at\": \"2019-06-19 21:22:03\",\n \"created_at\": \"2019-06-19 21:22:03\",\n \"files\": [],\n \"electronic_signature\": {\n \"html_content\": \"I agree to...\",\n \"ip\": \"42.1.1.113\",\n \"timestamp\": \"2019-06-19 21:22:03\",\n \"user_id\": \"a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8\",\n \"email\": \"john@doe.com\",\n \"browser_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36\"\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"annual_volume": {
"type": "string",
"example": ""
},
"avg_trans_size": {
"type": "string",
"example": ""
},
"b2b_percent": {
"type": "string",
"example": ""
},
"bank_account_type": {
"type": "string",
"example": ""
},
"business_address_1": {
"type": "string",
"example": ""
},
"business_address_2": {
"type": "string",
"example": ""
},
"business_address_city": {
"type": "string",
"example": ""
},
"business_address_country": {
"type": "string",
"example": ""
},
"business_address_state": {
"type": "string",
"example": ""
},
"business_address_zip": {
"type": "string",
"example": ""
},
"business_dba": {
"type": "string",
"example": ""
},
"business_email": {
"type": "string",
"example": ""
},
"business_fax": {
"type": "string",
"example": ""
},
"business_legal_name": {
"type": "string",
"example": ""
},
"business_open_date": {
"type": "string",
"example": ""
},
"business_phone_number": {
"type": "string",
"example": ""
},
"business_tax_id": {
"type": "string",
"example": ""
},
"business_website": {
"type": "string",
"example": ""
},
"card_not_present_percent": {
"type": "string",
"example": ""
},
"card_present_percent": {
"type": "string",
"example": ""
},
"card_swiped_percent": {
"type": "string",
"example": ""
},
"chosen_plan": {
"type": "string",
"example": ""
},
"chosen_processing_method": {
"type": "string",
"example": ""
},
"company_type": {
"type": "string",
"example": ""
},
"drivers_license_id": {
"type": "string",
"example": "M9K778578"
},
"drivers_license_state": {
"type": "string",
"example": "FL"
},
"email": {
"type": "string",
"example": ""
},
"first_name": {
"type": "string",
"example": ""
},
"highest_trans_amount": {
"type": "string",
"example": ""
},
"international": {
"type": "string",
"example": ""
},
"internet": {
"type": "string",
"example": ""
},
"job_title": {
"type": "string",
"example": ""
},
"last_name": {
"type": "string",
"example": ""
},
"location_type": {
"type": "string",
"example": ""
},
"mcc": {
"type": "string",
"example": "1750"
},
"meta": {
"type": "object",
"properties": {
"ownership_percentage": {
"type": "integer",
"example": 60,
"default": 0
},
"owner_citizenship": {
"type": "string",
"example": "ALA"
},
"representatives": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": ""
},
"date_of_birth": {
"type": "string",
"example": ""
},
"ssn": {
"type": "string",
"example": ""
},
"drivers_license_id": {
"type": "string",
"example": "M9K778578"
},
"drivers_license_state": {
"type": "string",
"example": "FL"
},
"first_name": {
"type": "string",
"example": ""
},
"last_name": {
"type": "string",
"example": ""
},
"type": {
"type": "string",
"example": ""
},
"ownership_percentage": {
"type": "integer",
"example": 40,
"default": 0
},
"email": {
"type": "string",
"example": ""
},
"phone": {
"type": "string",
"example": ""
},
"address_1": {
"type": "string",
"example": ""
},
"address_2": {
"type": "string",
"example": ""
},
"address_city": {
"type": "string",
"example": ""
},
"address_state": {
"type": "string",
"example": ""
},
"address_zip": {
"type": "string",
"example": ""
},
"citizenship": {
"type": "string",
"example": "ALA"
}
}
}
},
"stax_created_at": {
"type": "string",
"example": "2022-06-30"
},
"stax_netnew": {
"type": "boolean",
"example": true,
"default": true
},
"stax_months_processing": {
"type": "string",
"example": "0"
}
}
},
"moto_percent": {
"type": "string",
"example": ""
},
"network": {
"type": "string",
"example": ""
},
"owner_address_1": {
"type": "string",
"example": ""
},
"owner_address_2": {
"type": "string",
"example": ""
},
"owner_address_city": {
"type": "string",
"example": ""
},
"owner_address_country": {
"type": "string",
"example": ""
},
"owner_address_state": {
"type": "string",
"example": ""
},
"owner_address_zip": {
"type": "string",
"example": ""
},
"phone_number": {
"type": "string",
"example": ""
},
"plan": {
"type": "string",
"example": ""
},
"pricing_plan": {
"type": "string",
"example": "interchange0-15"
},
"principal_owners_name": {
"type": "string",
"example": ""
},
"reason_for_applying": {
"type": "string",
"example": ""
},
"referred_by": {
"type": "string",
"example": ""
},
"refund_policy": {
"type": "string",
"example": ""
},
"seasonal_flag": {
"type": "boolean",
"example": false,
"default": true
},
"seasonal_months": {
"type": "string",
"example": ""
},
"service_you_provide": {
"type": "string",
"example": ""
},
"title": {
"type": "string",
"example": ""
},
"user_dob": {
"type": "string",
"example": ""
},
"merchant_id": {
"type": "string",
"example": "791fc3fa-4534-4617-97b6-d41c9e1ce8da"
},
"user_id": {
"type": "string",
"example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8"
},
"updated_at": {
"type": "string",
"example": "2019-06-19 21:22:03"
},
"created_at": {
"type": "string",
"example": "2019-06-19 21:22:03"
},
"files": {
"type": "array"
},
"electronic_signature": {
"type": "object",
"properties": {
"html_content": {
"type": "string",
"example": "I agree to..."
},
"ip": {
"type": "string",
"example": "42.1.1.113"
},
"timestamp": {
"type": "string",
"example": "2019-06-19 21:22:03"
},
"user_id": {
"type": "string",
"example": "a01a5f74-cbdb-4704-9e9b-56fd5a8ee7b8"
},
"email": {
"type": "string",
"example": "john@doe.com"
},
"browser_agent": {
"type": "string",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36"
}
}
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"annual_volume\": [\n \"The annual volume may not be greater than 100 characters.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"annual_volume": {
"type": "array",
"items": {
"type": "string",
"example": "The annual volume may not be greater than 100 characters."
}
}
}
}
}
}
}
},
"security": [
{
"PartnerApiKey": []
}
]
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```