Skip to main content

Onboard an individual

Endpoint for onboarding an Individual Account.

POST /api/v1/revere_pay/signup_entry

Request Parameters

NameDescriptionTypeRequired
signup_form_idAsk our Revere Payments Hub admin for your ID.stringRequired
individual.name.first_nameFirst name of the Individual.stringRequired
individual.name.middle_nameMiddle name of the Individual.string
individual.name.last_nameLast name of the Individual.stringRequired
individual.name.titleAvailable values: 'mr', 'ms', 'mrs', 'mx'stringRequired
individual.phone.numberPhone number of the Individual.stringRequired
individual.phone.country_codeCountry code of the Individual's phone number. Supported country code is '1'.stringRequired
individual.emailEmail address of the Individual.stringRequired
individual.address.address_line_1Address line 1 of the Individual's address.stringRequired
individual.address.address_line_2Address line 2 of the Individual's address.string
individual.address.cityCity of the Individual's address.stringRequired
individual.address.subdivisionSubdivision of the Individual's address.stringRequired
individual.address.postal_codePostal Code of the Individual's address.stringRequired
individual.birth_date.yearYear of the Individual's Date of Birth.uint64Required
individual.birth_date.monthMonth of the Individual's Date of Birth.uint64Required
individual.birth_date.dayDay of the Individual's Date of Birth.uint64Required
individual.goverment_id.ssnSocial Security Number of the Individual.stringSSN or ITIN is Required
individual.goverment_id.itinTaxpayer Identification Number of the Individual.stringSSN or ITIN is Required

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 = '';
var headers = new Headers();

var requestOptions = {
method: 'POST',
headers: headers,
redirect: 'follow',
body: {
signup_form_id: signupFormID,
individual: {
name: {
first_name: 'John',
last_name: 'Doe',
middle_name: '',
title: 'mr'
},
phone: {
number: '2015551235',
code: '1'
},
email: 'johndoe@example.com',
address: {
address_line_1: '1st Ave.',
address_line_2: '1217',
city: 'New York',
subdivision: 'NY',
postal_code: '10065'
},
birth_date: {
year: 1990,
month: 7,
day: 4
},
goverment_id: {
ssn: '123456789'
}
}
}
};
fetch(`https://api.reverepayments.dev/api/v1/revere_pay/signup_entry`, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.log('error', error));