SDS API Reference

Welcome

Welcome to the SDS Developer Documentation Portal. We currently provide a small, secure API for creating borrowers and for retrieving some borrower information. We also provide the ability to subscribe to webhooks to receive notifications for when new borrowers are created or when important status changes happen for existing borrowers.

Security

We use a third party OAuth provider to secure access to our API. For your convenience, we have provided a relay method here as part of our API to allow you to acquire a JWT Bearer Token which you must provide to all of our API methods.

So, in order to obtain a token, first make a POST request to /api/authentication. The JSON body is:

{
    "username": "string",
    "password": "string"
}
            

{
    "token": "eyJraWQiOiJOMUhsbXd...",
    "success": "true",
    "message": "Success",
    "expiresIn": "600"
}
            

The token returned in this call needs to be added to all subsequent calls made. Add an HTTP Header named Authorization. The value is the word "Bearer" followed by the token. You can try this out via a tool like Postman:

/Me

To test authentication worked correctly, you can call the /Me method. This will return information about your user, including the channel to which you belong. Alternatively, if your user is at the agency level, then channels will be an array of all available channels.

https://borrower-api.myresolvent.com/api/me
            

{
    "username": "myuser.name",
    "channels": [
        {
            "name": "My Channel Name",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
    ]
}
            

Retrieving an Existing Borrower

Depending on your workflow, you may be notified of new borrowers via a webhook. Alternatively, you may choose to not keep certain details in your system of our borrowers and need to fetch those details. Use the following GET method:

https://borrower-api.myresolvent.com/api/borrowers?id=(your borrower id here)
            

Creating a Borrower

To create a borrower, use the following POST method:

{
    "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "zip": "string"
    },
    "name": {
        "firstName": "string",
        "lastName": "string"
    },
    "email": "string",
    "phone": {
        "number": "string",
        "isMobile": true
    },
    "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "acceptTCPA" : true
}