Activity

How to feed information about your users to the platform.

Not all the information can be share at the moment of the inference (ie: the call to the authorization endpoint). You can feed our platform data regarding your users so we can pre-process that and be prepared when they ask for a loan.

This process is done via sharing "activity data points" of the users. Those are sent identifying the user via it's document number.

Activity

Activity calls are done to the /v1/activity/<document>/ URI with an HTTP POST method.

The document parameter in the URL is formatted using the right mask, for example, in the case of a CPF (Brazil's ID) it should be in the XXX.XXX.XXX-NN format.

An example payload looks like this:

JSON

{
  "activity": "transaction.outgoing",
  "payload": {
    "amount": "47.59",
    "currency": "BRL",
    "timestamp": "2022-04-29T03:15:08Z",
    "category": "STORE_GROCERY"
  }
}

The overall structure always include an activity key with a string as its value, and a payload key with an object as its value. The key's of the payload's object are dynamic and usually defined during the onboarding.

The response to the calls to Activity are always an empty payload and a HTTP 202 (Accepted) status.