Sign-Up API

This endpoint does not require authentication.

If you want to customize the form, we also have an API that you can call from your server or from javascript with a simple HTTP POST. You are also able to attribute analytics data and referrer data in Approve Owl with this API.

If your website is powered by a client-side solution like React.js, we recommend using this API with custom components instead of our embedded form snippet.

curl --location --request POST 'https://vandelayautos.approvehub.com/sign_ups' \
--data-raw '{
    "applicant": {
        "full_name": "Jon Snow",
        "phone_number": "254-555-1234",
        "email_address": "[email protected]",
    },
    "analytics": {
        "google_analytics_tracking_id": "UA-25068374-1",
        "google_analytics_client_id": "GA1.1.148711805.1643395540",
        "google_analytics_session_id": "GA3.1.3458976324.834756912"
    }
}'

This is sent to your consumer portal Sign-Up API. It will create an applicant and send a verification code. The returned attributes allow you to redirect the applicant to the verification code challenge screen.

Applicant values of full_name, phone_number, and email_address are required.

The analytics object is optional. For more information about analytics attribution in Approve Owl using our Sign-Up API, please contact our development team before you being to use this API.

You will receive the following data back on a failure:

{
  "errors": {
    "full_name": ["can't be blank"]
  }
}

You will receive the following data back on success:

{
  "applicant_id": "6c3dbf6d-753c-4eb9-9626-ec3b7fe864d7",
  "session_url": "https://vandelayautos.approvehub.com/account/session/new",
  "verification_url": "https://vandelayautos.approvehub.com/account/session/edit?id=6c3dbf6d-753c-4eb9-9626-ec3b7fe864d7"
}

Redirecting the applicant to verification_url will allow them to enter their one-time password and proceed with the data collection process.