Sending Updates

This page explains how you should update us on an account registration attempt.

On this page:

When to send updates

Sending us updates on the outcome of each registration attempt will allow us to improve our recommendations. It also ensures that our dashboard will provide accurate reports on registration attempts.

After receiving a recommendation
You should update us with the outcome of the registration attempt after receiving and acting on a recommendation. In addition to helping us improve our future recommendations, if you notify us that a registration was successful, we will create the customer or supplier in our system so that we can associate future activity with the account.
After a registration fails validation, for certain reasons
If the registration attempt fails validation for certain reasons, you should update us. For example, you should update us if the registration fails validation because the email address or phone number is already registered; this is an indication that the user could be testing stolen credentials. However, you don’t need to update us if the registration fails validation for other reasons, for example, because the password is too short. Please speak to your Ravelin integration manager about updating us on validation failures.
After a registration fails verification
If you support mandatory email or phone verification during registration, and the user fails verification, you should update us.

How to send updates

To update us on the outcome of a registration attempt, send a request to our Registration Endpoint. This request will typically be made from your backend. Since you are not requesting a recommendation, do not use the Account Registration Checkpoint.

You should set the registration.success field to true or false depending on whether the registration was successful.

`success` value	Meaning
`true`	The registration was successful and the account was created.
`false`	The registration attempt was unsuccessful and the account was not created.

An example request is shown below:

POST https://api.ravelin.com/v2/registration HTTP/1.1
Authorization: token ...
Content-Type: application/json

{
  "timestamp": 1512828988826,
  "registration": {
    "username": "jsmith123@example.com",
    "success": true,
    "registrationMechanism": {
      "password": {
        "passwordHashed": "ef92b778bafe771e89245b89ecbc08a44a4e166c06659911881f383d4473e94f",
        "success": true
      }
    }
  },
  "customer": {
    "email": "jsmith123@example.com",
    "emailVerifiedTime": 1512828988826,
    "name": "John Smith",
    "familyName": "Smith",
    "givenName": "John",
    "telephone": "+16045555555",
    "telephoneVerifiedTime": 1512828988826,
    "telephoneCountry": "DOM"
  },
  "device": {
    "deviceId": "a1b2c3d4e5f6",
    "type": "phone",
    "manufacturer": "google",
    "model": "Pixel XL",
    "os": "android",
    "ipAddress": "81.152.92.84",
    "language": "en-US",
    "location": {
      "latitude": 51.503252,
      "longitude": -0.127899
    }
  }
}

Our response will just contain a 200 OK status code to acknowledge the update.

An example response is shown below:

{
  "status": 200,
  "timestamp": 1512828998826
}

Next steps

Test your account registration integration

Feedback

Was this page helpful?