Integrated Ordering

Integrated ordering streamlines the loan documentation process by enabling lenders to initiate, configure, and submit document orders with an integrated experience using GoDocs open API services. this seamless integration eliminates the need to switch between systems, reduces manual data entry, and ensure consistency across platforms.

Integrated ordering is achieved when providers invoke the following workflow:

Workflow Demo

This is a video of the integrated ordering workflow experience.

Integrated Order Page

Route


/login/sso/io/{packageId}?username={email}

Summary

  • URL used to click, popup, or navigate

    • SSO user into GoDocs using integrators IDP

    • Navigate GoDocs Order Screen to display on successful navigation

Parameters

  • Query Params:

    • packageId

    • username

      • datatype: string

      • description: username of to be used in sso login

 

Implementation Examples

//JavaScript

let url = `${goDocsApplicationEnvUrl}/login/sso/io/${referenceId}?username=${username}`; window.open(   url,   "_blank",   "height=800,width=1000,toolbar=no,location=no,menubar=no" );

##Python (using webbrowser module)

import webbrowser
url = f"{goDocsApplicationEnvUrl}/login/sso/io/{referenceId}?username={username}" webbrowser.open_new_tab(url)

 

Order

Order Status

Route

order/status?companyId={{companyId}}&recordId={{recordId}}

Description

  • Returns status of order to indicate when documents can be downloaded

Http Request Type

GET

Parameters

  1. Query Parameters:

    1. companyId:

      1. datatype: uuid | string

        1. to be provided by GoDocs

    2. recordId:

      1. datatype: uuid | string

Response Models

200

{   "data": "Complete",   "success": true,    "message": null}
{   "data": "Incomplete",   "success": true,    "message": null}

400

{   "data": null,   "success": false,    "message": "Order status not found"}

Download

Loan

Route

document/download/loan?companyId={{companyId}}&recordId={{recordId}}

Description

  • download loan documents by recordId and companyId after an order is completed either through the order/submit or through the application

Http Request Type

GET

Parameters

  1. Query Parameters:

    1. companyId:

      1. datatype: uuid | string

        1. to be provided by GoDocs

    2. recordId:

      1. datatype: uuid | string

    3. docType

      1. datatype: "pdf" | "docx"

Response Type: Stream

Order Summary

Route

document/download/summary?companyId={{companyId}}&recordId={{recordId}}

Description

  • download summary page as stream by recordId and companyId after an order is completed either through the order/submit or through the application

Http Request Type

GET

Parameters

  1. Query Parameters:

    1. companyId:

      1. datatype: uuid | string

        1. to be provided by GoDocs

    2. recordId:

      1. datatype: uuid | string

Response Type: Stream