Getting Started

Overview

The nCino Developer Portal (this site) is the best place to get started! Here you will find Getting Started materials, detailed guides and walkthroughs, API reference documentation, access to a robust Postman Collection and recipes to get you started with some of the more common workflows used by customers.

Obtaining API Credentials

In order to use the nCino Mortgage API, you will need a set of API Credentials granting you access to the system. For more information, see Obtaining API Credentials and Authorizing Endpoints.

Postman Collection

To help you get started, we have provided a that contains a full set of API resources you can use to interact with and use during the development of your integration.

For more information on installing the Postman Collection and setting it up your credentials, see Postman Collection

Making your First Call to the API

Now that you have API Credentials and Postman configured, you are ready to make your first call to the API.

The simplest way to verify that you have authenticated properly is to make a simple GET call to the API.

For example, if you call GET /companies, you should receive back a response that provides basic information about any companies that the API Credentials are authorized to access. Here is an example response:

{
    "_self": "/companies",
    "_type": "Page",
    "_links": {
        "first": "/companies?page=1",
        "last": "/companies?page=1",
        "next": "/companies?page=1"
    },
    "contents": [
        {
            "_self": "/companies/f5ee493d-6749-4376-a93d-7b3435c14684",
            "_type": "Company",
            "_links": {
                "default_loan_officer": "/users/loan_officers/2e6cd890-1a7c-4956-8a53-4fc2b3ff1a02"
            },
            "id": "f5ee493d-6749-4376-a93d-7b3435c14684",
            "name": "W Test",
            "address": {
                "_self": "/companies/f5ee493d-6749-4376-a93d-7b3435c14684#address",
                "_type": "Address",
                "_links": {},
                "street1": "123 Test Street",
                "street2": "",
                "city": "Test City",
                "state": "UT",
                "zip": "99999"
            },
            "nmls": "1234567",
            "support_email": "[email protected]",
            "tech_contact_email": "[email protected]",
            "internal_phone": "1.855.684.2777",
            "app_icon_url": "https://images.simplenexus.com/company/app_icon/111230/e33a3ecc-ec08-469b-a119-bc4b3273ac5d.png",
            "mobile_homepage_logo_url": "https://images.simplenexus.com/app_homepage_logo/logo/184/b5583f18-29f8-4a9f-a072-217d62c8ef81.png",
            "logo_url": "https://images.simplenexus.com/company/logo/111230/04953f06-848b-4695-9610-f1deeb015708.png",
            "apple_store_url": "https://itunes.apple.com/us/app/id509965767?ls=1&mt=8",
            "google_play_store_url": "https://play.google.com/store/apps/details?id=com.simplenexus.loans.client"
        }
    ],
    "total_pages": 1,
    "total": 1
}