Skip to main content

Onboard a business

Endpoint for onboarding a Business Account.

POST /api/v1/revere_pay/signup_entry

Request Parameters​

Business Information​

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. Accepted format: [À-ÖØ-öø-ÿ"'(),.0-9A-Za-z~ &!+-]+stringRequired
business.doing_business_asA registered trade name under which the Business operates, if different from its legal name. Accepted format: [À-ÖØ-öø-ÿ"'(),.0-9A-Za-z~ &!+-]+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. Accepted format: [a-zA-Z0-9,.\/?:'"|~!@#$%^&*()+_= -]+stringDescription or Website is Required
business.einEIN (employer identification number) for the Business. Required for all business types. For soleProprietorship, SSN can be used instead.stringRequired
business.ssnSSN (Social Security Number) for sole proprietors. Can be used instead of EIN when business_type is soleProprietorship.string
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. Accepted format: [a-zA-Z0-9,.\/?:'"|~!@#$%^&*()+_= -]+stringRequired
business.address_line_2Address line 2 of the Business' address. Accepted format: [a-zA-Z0-9,.\/?:'"|~!@#$%^&*()+_= -]*string
business.cityCity of the Business' address. Accepted format: [a-zA-Z0-9,.\/?:'"|~!@#$%^&*()+_= -]+stringRequired
business.subdivisionSubdivision of the Business' address.stringRequired
business.postal_codePostal Code of the Business' address.stringRequired

Representatives​

NameDescriptionTypeRequired
business.representativesAn array of Business Representatives.arrayRequired
business.representatives.first_nameFirst name of the Representative.stringRequired
business.representatives.middle_nameMiddle name of the Representative.string
business.representatives.last_nameLast name of the Representative.stringRequired
business.representatives.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

Legacy Transaction Fields​

Deprecated

The following three fields are deprecated. Use the new Underwriting section instead. These fields are still accepted for backward compatibility when the underwriting object is not provided.

NameDescriptionTypeRequired
business.average_monthly_transaction_volumeAverage monthly transaction volume of the Business.stringDeprecated Required only when underwriting is not provided
business.max_transaction_sizeMaximum transaction size the Business can process.uint64Deprecated Required only when underwriting is not provided
business.average_transaction_sizeAverage transaction size of the Business.uint64Deprecated Required only when underwriting is not provided

Underwriting​

info

When the underwriting object is provided, the legacy fields (average_monthly_transaction_volume, max_transaction_size, average_transaction_size) are ignored. The underwriting object is the recommended approach for new integrations.

NameDescriptionTypeRequired
business.underwriting.payment_methodsPayment methods the business will use. At least one value is required. Available values: card, ach.arrayRequired
business.underwriting.geographich_reachGeographic reach of the business. Available values: international-only, us-and-international, us-only.stringRequired
business.underwriting.business_presenceType of business presence. Available values: commercial-office, home-based, mixed-presence, mobile-business, online-only, retail-storefront.string
business.underwriting.pending_litigationPending litigation status. See Pending Litigation values.string
business.underwriting.volume_by_customer_type.b2bPercentage of volume from B2B customers. Must sum to 100 with b2c and p2p.uint64
business.underwriting.volume_by_customer_type.b2cPercentage of volume from B2C customers. Must sum to 100 with b2b and p2p.uint64
business.underwriting.volume_by_customer_type.p2pPercentage of volume from P2P transactions. Must sum to 100 with b2b and b2c.uint64
business.underwriting.collect_funds.achACH collect funds configuration. Required when ach is in payment_methods.object
business.underwriting.collect_funds.cardCard collect funds configuration. Required when card is in payment_methods.object
business.underwriting.send_funds.achACH send funds configuration.objectRequired
business.underwriting.send_funds.instant_bankInstant bank send funds configuration.objectRequired

Collect Funds — ACH​

Required when ach is included in payment_methods. Fields are nested under business.underwriting.collect_funds.ach.

NameDescriptionTypeRequired
expected_transaction_activity.average_transaction_amountAverage ACH collect transaction amount.uint64Required
expected_transaction_activity.maximum_transaction_amountMaximum ACH collect transaction amount.uint64Required
expected_transaction_activity.monthly_volume_rangeMonthly volume range. See Monthly Volume Range values.stringRequired

Collect Funds — Card​

Required when card is included in payment_methods. Fields are nested under business.underwriting.collect_funds.card.

NameDescriptionTypeRequired
expected_transaction_activity.average_transaction_amountAverage card collect transaction amount.uint64Required
expected_transaction_activity.maximum_transaction_amountMaximum card collect transaction amount.uint64Required
expected_transaction_activity.monthly_volume_rangeMonthly volume range. See Monthly Volume Range values.stringRequired
acceptance_methods.in_personPercentage of in-person card transactions. Must sum to 100 with online and mail_or_phone.uint64Required
acceptance_methods.onlinePercentage of online card transactions. Must sum to 100 with in_person and mail_or_phone.uint64Required
acceptance_methods.mail_or_phonePercentage of mail/phone card transactions. Must sum to 100 with in_person and online.uint64Required
currently_accepts_cardWhether the business currently accepts card payments.booleanRequired
fulfillment_methodHow orders are fulfilled. See Fulfillment Method values. Required when in_person < 80.string
fulfillment_timeframeTypical fulfillment timeframe. See Fulfillment Timeframe values. Required when in_person < 80.string
refund_policyBusiness refund policy. See Refund Policy values. Required when in_person < 80.string

Send Funds — ACH​

Fields are nested under business.underwriting.send_funds.ach.

NameDescriptionTypeRequired
expected_transaction_activity.average_transaction_amountAverage ACH send transaction amount.uint64Required
expected_transaction_activity.maximum_transaction_amountMaximum ACH send transaction amount.uint64Required
expected_transaction_activity.monthly_volume_rangeMonthly volume range. See Monthly Volume Range values.stringRequired

Send Funds — Instant Bank​

Fields are nested under business.underwriting.send_funds.instant_bank.

NameDescriptionTypeRequired
expected_transaction_activity.average_transaction_amountAverage instant bank send transaction amount.uint64Required
expected_transaction_activity.maximum_transaction_amountMaximum instant bank send transaction amount.uint64Required
expected_transaction_activity.monthly_volume_rangeMonthly volume range. See Monthly Volume Range values.stringRequired

Documents​

NameDescriptionTypeRequired
business.processing_statements.first_month_file_idID of the first processing statement file previously uploaded. See Processing Statement.string
business.processing_statements.second_month_file_idID of the second processing statement file previously uploaded. See Processing Statement.string
business.processing_statements.third_month_file_idID of the third processing statement file previously uploaded. See Processing Statement.string
business.bank_statements.first_month_file_idID of the first bank statement file previously uploaded. See Bank Statement.string
business.bank_statements.second_month_file_idID of the second bank statement file previously uploaded. See Bank Statement.string
business.bank_statements.third_month_file_idID of the third bank statement file previously uploaded. See Bank Statement.string
Document Requirements
  • Processing Statements (3 months) are required when underwriting.collect_funds.card.currently_accepts_card is true.
  • Bank Statements (3 months) are required when processing statements are not required (i.e., the business does not currently accept card payments).
  • When using the legacy fields (without the underwriting object), processing statements are always required.

Conditional Field Rules​

note

The following fields become required when geographich_reach is NOT us-only OR when any monthly_volume_range across all sections is above under-10k:

  • business.underwriting.business_presence
  • business.underwriting.pending_litigation
  • business.underwriting.volume_by_customer_type (b2b, b2c, p2p)

The card fulfillment fields (fulfillment_method, fulfillment_timeframe, refund_policy) become required when acceptance_methods.in_person is less than 80.

Monthly Volume Range Values​

ValueDescription
under-10kUnder $10,000
10k-50k$10,000 - $50,000
50k-100k$50,000 - $100,000
100k-250k$100,000 - $250,000
250k-500k$250,000 - $500,000
500k-1m$500,000 - $1,000,000
1m-5m$1,000,000 - $5,000,000
over-5mOver $5,000,000

Fulfillment Method Values​

bill-or-debt-payment, digital-content, donation, in-person-service, local-pickup-or-delivery, other, remote-service, shipped-physical-goods, subscription-or-membership

Fulfillment Timeframe Values​

immediate, other, over-30-days, pre-order, recurring-schedule, scheduled-event, within-30-days, within-7-days

Refund Policy Values​

conditional-refund, custom-policy, event-based-policy, full-refund-extended-window, full-refund-within-30-days, no-refunds, partial-refund, prorated-refund, store-credit-only

Pending Litigation Values​

bankruptcy-or-insolvency, consumer-protection-or-class-action, data-breach-or-privacy, employment-or-workplace-disputes, fraud-or-financial-crime, government-enforcement-or-investigation, intellectual-property, none, other, personal-injury-or-medical

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',
		underwriting: {
			payment_methods: ['card', 'ach'],
			geographich_reach: 'us-only',
			collect_funds: {
				ach: {
					expected_transaction_activity: {
						average_transaction_amount: 5000,
						maximum_transaction_amount: 25000,
						monthly_volume_range: 'under-10k'
					}
				},
				card: {
					expected_transaction_activity: {
						average_transaction_amount: 200,
						maximum_transaction_amount: 20000,
						monthly_volume_range: 'under-10k'
					},
					acceptance_methods: {
						in_person: 80,
						online: 15,
						mail_or_phone: 5
					},
					currently_accepts_card: true
				}
			},
			send_funds: {
				ach: {
					expected_transaction_activity: {
						average_transaction_amount: 3000,
						maximum_transaction_amount: 15000,
						monthly_volume_range: 'under-10k'
					}
				},
				instant_bank: {
					expected_transaction_activity: {
						average_transaction_amount: 1000,
						maximum_transaction_amount: 5000,
						monthly_volume_range: 'under-10k'
					}
				}
			}
		},
		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));