Skip to main content

Onboard an individual

Endpoint for onboarding an Individual as a Sole Proprietorship 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_typeMust be soleProprietorship for individual onboarding.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). Exactly one of ein or ssn must be provided.stringEIN or SSN is Required
business.ssnSSN (Social Security Number) for sole proprietors. Exactly one of ein or ssn must be provided.stringEIN or SSN is Required
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

Underwriting​

NameDescriptionTypeRequired
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.send_funds.achACH send funds configuration.objectRequired
business.underwriting.send_funds.instant_bankInstant bank send funds configuration.objectRequired
Conditional Field Rules

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

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

Transaction amounts (average_transaction_amount, maximum_transaction_amount) are optional when monthly_volume_range is under-10k.

Send Funds — ACH​

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

NameDescriptionTypeRequired
expected_transaction_activity.average_transaction_amountAverage ACH send transaction amount.uint64Required when monthly_volume_range is not under-10k
expected_transaction_activity.maximum_transaction_amountMaximum ACH send transaction amount.uint64Required when monthly_volume_range is not under-10k
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 when monthly_volume_range is not under-10k
expected_transaction_activity.maximum_transaction_amountMaximum instant bank send transaction amount.uint64Required when monthly_volume_range is not under-10k
expected_transaction_activity.monthly_volume_rangeMonthly volume range. See Monthly Volume Range values.stringRequired

Documents​

Bank statements (3 months) are required for individuals.

NameDescriptionTypeRequired
business.bank_statements.first_month_file_idID of the first bank statement file previously uploaded. See Bank Statement.stringRequired
business.bank_statements.second_month_file_idID of the second bank statement file previously uploaded. See Bank Statement.stringRequired
business.bank_statements.third_month_file_idID of the third bank statement file previously uploaded. See Bank Statement.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-individual.js
const signupFormID = 'YOUR_SIGNUP_FORM_ID';

const body = {
	signup_form_id: signupFormID,
	business: {
		business_name: 'Jane Smith Services',
		doing_business_as: 'Jane Smith',
		business_type: 'soleProprietorship',
		description: 'Freelance consulting services',
		ssn: '123456789',
		industry_mcc: '7392',
		phone: {
			number: '2015551235',
			country_code: '1'
		},
		email: 'jane@example.com',
		website: 'https://janesmith.com',
		address_line_1: '123 Main St',
		city: 'New York',
		subdivision: 'NY',
		postal_code: '10065',
		underwriting: {
			geographich_reach: 'us-only',
			send_funds: {
				ach: {
					expected_transaction_activity: {
						average_transaction_amount: 1000,
						maximum_transaction_amount: 5000,
						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: 'Jane',
				last_name: 'Smith',
				title: 'ms',
				phone: {
					number: '2015551235',
					country_code: '1'
				},
				email: 'jane@example.com',
				address_line_1: '123 Main St',
				city: 'New York',
				subdivision: 'NY',
				postal_code: '10065',
				birth_date: {
					year: 1990,
					month: 6,
					day: 15
				},
				ssn: '123456789',
				is_controller: true,
				is_owner: true,
				ownership_percentage: 100,
				job_title: 'Owner'
			}
		],
		bank_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));