Skip to main content

Onboard a business

Endpoint for onboarding a Business Account.

POST /api/v1/revere_pay/signup_entry

Request Parameters​

NameDescriptionTypeRequired
signup_form_idAsk our Revere Payments Hub admin for your ID.stringRequired
external_idAn optional external identifier for the entity with the maximum length of 36 characters. This identifier will be attached to the Hub account.string
business.business_nameLegal name of the Business.stringRequired
business.doing_business_asA registered trade name under which the Business operates, if different from its legal name.stringRequired
business.business_typeType of the business. Possible values: 'soleProprietorship', 'unincorporatedAssociation', 'trust', 'publicCorporation', 'privateCorporation', 'llc', 'partnership', 'unincorporatedNonProfit', 'incorporatedNonProfit', 'governmentEntity'.stringRequired
business.descriptionDescription of the business with the maximum length of 100 characters. Business description or website is required.stringDescription or Website is Required
business.einEIN (employer identification number) for the Business.stringRequired
business.industry_mccMCC industry code of the Business.stringRequired
business.phone.numberPhone number of the Business.stringRequired
business.phone.country_codeCountry code of the Business' phone number. Supported country code is '1'.stringRequired
business.emailEmail address of the Business.stringRequired
business.websiteWebsite address of the Business. Business description or website is required.stringDescription or Website is Required
business.address_line_1Address line 1 of the Business' address.stringRequired
business.address_line_2Address line 2 of the Business' address.string
business.cityCity of the Business' address.stringRequired
business.subdivisionSubdivision of the Business' address.stringRequired
business.postal_codePostal Code of the Business' address.stringRequired
business.average_monthly_transaction_volumeAverage monthly transaction volume of the Business.stringRequired
business.max_transaction_sizeMaximum transaction size the Business can process.uint64Required
business.average_transaction_sizeAverage transaction size of the Business.uint64Required
business.representativesAn array of Business Representatives.arrayRequired
business.representatives.name.first_nameFirst name of the Representative.stringRequired
business.representatives.name.middle_nameMiddle name of the Representative.string
business.representatives.name.last_nameLast name of the Representative.stringRequired
business.representatives.name.titleTitle of the Representative. Available values: 'mr', 'ms', 'mrs', 'mx'.stringRequired
business.representatives.phone.numberPhone number of the Representative.stringRequired
business.representatives.phone.country_codeCountry code of the Representative's phone number. Supported country code is '1'.stringRequired
business.representatives.emailEmail address of the Representative.stringRequired
business.representatives.address_line_1Address line 1 of the Representative's address.stringRequired
business.representatives.address_line_2Address line 2 of the Representative's address.string
business.representatives.cityCity of the Representative's address.stringRequired
business.representatives.subdivisionSubdivision of the Representative's address.stringRequired
business.representatives.postal_codePostal Code of the Representative's address.stringRequired
business.representatives.birth_date.yearYear of the Representative's Date of Birth.uint64Required
business.representatives.birth_date.monthMonth of the Representative's Date of Birth.uint64Required
business.representatives.birth_date.dayDay of the Representative's Date of Birth.uint64Required
business.representatives.ssnSocial Security Number of the Representative.stringSSN or ITIN is Required
business.representatives.itinIndividual Taxpayer Identification Number of the Representative.stringSSN or ITIN is Required
business.representatives.is_controllerIndicates whether the Representative has controlling authority in the Business.booleanRequired
business.representatives.is_ownerIndicates whether the Representative is an owner of the Business.booleanRequired
business.representatives.ownership_percentageIndicates the ownership percentage of the Business held by the Representative.uint64Required
business.representatives.job_titleSpecifies the Representative’s job title within the Business.stringRequired
business.processing_statements.first_month_file_idID of the first processing statement file previously uploaded. See the Processing Statement section for details.stringRequired
business.processing_statements.second_month_file_idID of the second processing statement file previously uploaded. See the Processing Statement section for details.stringRequired
business.processing_statements.third_month_file_idID of the third processing statement file previously uploaded. See the Processing Statement section for details.stringRequired

Response​

CodeDescription
201Created
202Created, but there was an error sending the confirmation email. Please contact support
400Bad Request / Validation error
500Internal Error

Example Usage​

onboarding.js
const signupFormID = 'YOUR_SIGNUP_FORM_ID';

const body = {
	signup_form_id: 'signupFormID',
	business: {
		business_name: 'Example Business',
		doing_business_as: 'Example',
		business_type: 'llc',
		description: 'E-commerce and retail services',
		ein: '123456789',
		industry_mcc: '5732',
		phone: {
			number: '2015551235',
			country_code: '1'
		},
		email: 'info@example.com',
		website: 'https://example.com',
		address_line_1: '123 Main St',
		address_line_2: 'Suite 400',
		city: 'New York',
		subdivision: 'NY',
		postal_code: '10065',
		average_monthly_transaction_volume: 500000,
		max_transaction_size: 20000,
		average_transaction_size: 200,
		representatives: [
			{
				first_name: 'Alice',
				middle_name: '',
				last_name: 'Smith',
				title: 'ms',
				email: 'alice.smith@example.com',
				phone: {
					number: '2015559876',
					country_code: '1'
				},
				birth_date: {
					year: 1985,
					month: 5,
					day: 14
				},
				ssn: '123456789',
				address_line_1: '456 Park Ave',
				address_line_2: '',
				city: 'New York',
				subdivision: 'NY',
				postal_code: '10022',
				is_controller: true,
				is_owner: true,
				ownership_percentage: 60,
				job_title: 'CEO'
			}
		],
		processing_statements: {
			first_month_file_id: '{{file1_id}}',
			second_month_file_id: '{{file2_id}}',
			third_month_file_id: '{{file3_id}}'
		}
	}
};

fetch('https://api.reverepayments.dev/api/v1/revere_pay/signup_entry', {
	method: 'POST',
	headers: { 'Content-Type': 'application/json' },
	body: JSON.stringify(body)
})
	.then((res) => res.json())
	.then((result) => console.log(result))
	.catch((err) => console.error(err));