Onboard an individual
Endpoint for onboarding an Individual Account.
POST /api/v1/revere_pay/signup_entry
Request Parameters
Name | Description | Type | Required |
---|---|---|---|
signup_form_id | Ask our Revere Payments Hub admin for your ID. | string | Required |
individual.name.first_name | First name of the Individual. | string | Required |
individual.name.middle_name | Middle name of the Individual. | string | |
individual.name.last_name | Last name of the Individual. | string | Required |
individual.name.title | Available values: 'mr', 'ms', 'mrs', 'mx' | string | Required |
individual.phone.number | Phone number of the Individual. | string | Required |
individual.phone.country_code | Country code of the Individual's phone number. Supported country code is '1'. | string | Required |
individual.email | Email address of the Individual. | string | Required |
individual.address.address_line_1 | Address line 1 of the Individual's address. | string | Required |
individual.address.address_line_2 | Address line 2 of the Individual's address. | string | |
individual.address.city | City of the Individual's address. | string | Required |
individual.address.subdivision | Subdivision of the Individual's address. | string | Required |
individual.address.postal_code | Postal Code of the Individual's address. | string | Required |
individual.birth_date.year | Year of the Individual's Date of Birth. | uint64 | Required |
individual.birth_date.month | Month of the Individual's Date of Birth. | uint64 | Required |
individual.birth_date.day | Day of the Individual's Date of Birth. | uint64 | Required |
individual.goverment_id.ssn | Social Security Number of the Individual. | string | SSN or ITIN is Required |
individual.goverment_id.itin | Taxpayer Identification Number of the Individual. | string | SSN or ITIN is Required |
Response
Code | Description |
---|---|
201 | Created |
202 | Created, but there was an error sending the confirmation email. Please contact support |
400 | Bad Request / Validation error |
500 | Internal Error |
Example Usage
- JavaScript
- Python
- Go
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));
onboarding.py
import requests
url = "https://api.reverepayments.dev/api/v1/revere_pay/signup_entry"
headers = {}
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'
}
}
}
response = requests.request("POST", url, headers=headers, body=body)
print(response.text)
onboarding.go
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
signupFormID := ""
req := `
{
"signup_form_id": "%s",
"individual": {
"name": {
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"title": "mr"
},
"birth_date": {
"year": 1990,
"month": 7,
"day": 4
},
"government_id": {
"itin": "",
"ssn": "123456789"
},
"phone": {
"number": "2015551235",
"country_code": "1"
},
"email": "johndoe@example.com",
"address": {
"address_line_1": "1st Ave.",
"address_line_2": "1217",
"city": "New York",
"subdivision": "NY",
"postal_code": "10065"
}
}
}
`
req = fmt.Sprintf(req, signupFormID)
url := "https://api.reverepayments.dev/api/v1/revere_pay/signup_entry"
client := &http.Client{}
httpReq, _ := http.NewRequest("POST", url, bytes.NewBufferString(req))
res, _ := client.Do(httpReq)
defer res.Body.Close()
bytes, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err.Error())
return
}
fmt.Println(string(bytes))
}