Digital lending

Hook notifications

5min

Hooks is a notification system, used by Arix, to update you on the status of your loan. Hooks report to your system with real-time notifications when an event happens on Arix. You have to register to receive hooks for each relevant event type by configuring the destination and delivery method, most commonly webhooks. When that event occurs, a Hook is triggered and reports the updates to your system via the chosen delivery method.
For example, if a rail status changes to returned, a RailUpdated hook event would be triggered, and reported to the partner notifying them of the event. This notification will only be sent out, if you have previously registered to receive this type of event (RailUpdated), and the registration is active.
IMPORTANT
To access the links below you must have the following IP addresses allowlisted:
Sandbox - 66.206.202.39 , 66.206.202.12
Production -66.206.202.62 , 66.206.202.15
Swagger: https://lendingsandbox.crbcos.com/hooks/swagger/index.html﻿
Base URL for sandbox: https://lendingsandbox.crbcos.com/﻿
Sandbox UI: https://lendingappsandbox.crbcos.com/hooks/registrations﻿
Production UI: https://lendingapp.crbcos.com/hooks/registrations﻿
API Scope:
CosLending:Hooks:stg for sandbox
CosLending:Hooks:prd for production
By default, a webhook that fails will retry 3 times with a delay interval of 5 minutes. Different Intervals can be configured for a registration by the CR support team.
Events can also be resent manually via the hooks UI, although there is a retention policy of 60 days for events in the system. 
Sample Events
LoanStatusUpdate
This event is reported every time the status of a loan is changed.
JSON
{
    "Id": 0,
    "LoanId": "3f07773b-5ba5-43e6-bf30-aea200361dad",
    "Status": 104,
    "TimeStamp": "2022-05-30T03:17:43.6233616+00:00",
    "DateInserted": "0001-01-01T00:00:00+00:00"
}
{
    "Id": 0,
    "LoanId": "3f07773b-5ba5-43e6-bf30-aea200361dad",
    "Status": 104,
    "TimeStamp": "2022-05-30T03:17:43.6233616+00:00",
    "DateInserted": "0001-01-01T00:00:00+00:00"
}
﻿
ComplianceLoanFailed
This event is reported every time the loan fails to pass all compliance checks.
JSON
{
     "MPLId": "xxx",
     "LoanId": "...guid...",
     "CreateDate": "date",
     "FailedRulesReasons": [
        {
           "RuleName": "rule name",
           "Rule": "some string",
           "Data": "some string",
           "Result": true,
           "FailedComplianceID": 67
        }
     ]
  }
{
     "MPLId": "xxx",
     "LoanId": "...guid...",
     "CreateDate": "date",
     "FailedRulesReasons": [
        {
           "RuleName": "rule name",
           "Rule": "some string",
           "Data": "some string",
           "Result": true,
           "FailedComplianceID": 67
        }
     ]
  }
﻿
RailUpdated
This event is reported when there is a status update to a rail that was requested
JSON
{ 
      "Id":0,
      "RailId":"…ID of rail that is received when rail created…",
      "LoanId":"fd331267-6ac2-4818-9d0f-ab2f00747b61",
      "RailType":8,
      "AmountFunded":8500.0,
      "RailTransactionId":"…railid from cos…",
      "FundResult": int(this is enum RailResultType), 
      "Message":"Description of rail created if no error returned",
      "ProcessedAt":"2019-12-26T07:05:09Z",
      "TransactionGroupId":"9dde776d-0c04-4bc8-9c9c-e0ad9a83c447"
   }
{ 
      "Id":0,
      "RailId":"…ID of rail that is received when rail created…",
      "LoanId":"fd331267-6ac2-4818-9d0f-ab2f00747b61",
      "RailType":8,
      "AmountFunded":8500.0,
      "RailTransactionId":"…railid from cos…",
      "FundResult": int(this is enum RailResultType), 
      "Message":"Description of rail created if no error returned",
      "ProcessedAt":"2019-12-26T07:05:09Z",
      "TransactionGroupId":"9dde776d-0c04-4bc8-9c9c-e0ad9a83c447"
   }
﻿
﻿

🤔

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.

﻿

Updated 12 Nov 2024

Did this page help you?

Card parameters