Refer - Refer a Client

The Wealth.com platform allows for external partners to refer a client via our Referral API. This API will initiate a partner specific onboarding flow that will allow the client to have their onboarding experience streamlined with data provided in the referral request.

POSTreferral-api.wealth.com/v1/refer/[partner-id]

Refer a Client

The Refer Request Object model contains all the information about the client and which wealth.com subscription or product they are being directed to.

Headers

Name
x-api-key
Type
string
Description
API Key provided by Wealth
Name
user-data-signature
Type
string
Description
Digital signature used to validate the sender of the request (further details can be found below in the Security section)

Request Object

Name
product
Type
integer
Description
Value options: 1: will (default), 2: trust, 3: ahcd, 4: fpoa
Name
token
Type
string (Max 36)
Description
user-specific token
Name
user
Type
user object
Description
The client data object

User Object

Name
email
Type
string (Max 320)
Description
The clients email address.
Name
firstName
Type
string (Max 100)
Description
The clients legal first name.
Name
lastName
Type
string (Max 100)
Description
The clients legal last name.
Name
hasPets
Type
boolean
Description
True indicates the client has pets.
Name
maritalStatus
Type
integer
Description
Value options: 1: single, 2: married, 3: domestic partnership, 4: civil union, 5: engaged, 6: other committed relationship
Name
address
Type
Address object
Description
The clients address.

Address Object

Name
address_line1
Type
string (Max 255)
Description
Address Line 1.
Name
address_line2 (optional)
Type
string (Max 150)
Description
Address Line 2.
Name
city
Type
string (Max 255)
Description
City, district, suburb, town, or village.
Name
state
Type
string (Max 2)
Description
State (e.g., California).
Name
postal_code
Type
string (Max 10)
Description
Postal code.

Request

POST

https://referral-api.wealth.com/v1/refer/partner-id

curl 'https://referral-api.wealth.com/v1/refer/{YOUR PARTNER ID}' \
  -H 'x-api-key: [YOUR API KEY]' \
  -H 'user-data-signature: [YOUR SIGNITURE]' \
  -d 'product'='1' \
  -d 'token'='190e0d68-5b93-4498-a6e8-305b0935f7b9' \
  -d 'user[firstName]'='Adam' \
  -d 'user[lastName]'='West' \
  -d 'user[hasPets]'='true' \
  -d 'user[maritalStatus]'='1' \
  -d 'user[address][address_line1]'='505 Golden Road' \
  -d 'user[address][city]'='Sacramento' \
  -d 'user[address][state]'='CA' \
  -d 'user[address][postal_code]'='99001'

Example Request JSON

{
  {
   "product": 1,
   "token": "a945225b-cab5-4775-81fd-90101319b994",
   "user": {
          "email": "jonny@email.com",
          "firstName": "John",
          "lastName": "Smith",
          "maritalStatus": "married",
          "hasPets": true
          "address": {
                 "line1": "1625 E Berridge Lane",
                 "line2": "",
                 "city": "Phoenix",
                 "state": "AZ",
                 "zip": "85016"}
    }
  }
}

Response Object

Name
referralToken
Type
string (Max 36)
Description
Identifier used during the onboarding process to identify a Wealth user as an external referral.
Name
url
Type
string (Max 2048)
Description
The URL that the user should be redirected to.

Response

 {
    "referralToken": "9eca742e-f3f2-4038-9dec-92a956a395a3",
    "url": "https://app.wealth.com/register?cid=customer&cta=will&prefillToken=9eca742e-f3f2-4038-9dec-92a956a395a3"
 }