JSON Import
Current API Version: v2.2.1
Environment Information
Development Lending API URL: https://api-uat-lending.godocs.com/
Testing Application to verify details: https://testing.godocs.com/
Note: if you require access to verify details on our testing site, please reach out to us at support@godocs.com
Reference
GoDocs JSON Library: GoDocs Import JSON Samples and JSON Schema
Endpoints
Import v2 (import/v2/json)
Description
validates JSON request data based on version based on the import type indicated with batching capabilities
imports data into GoDocs application
Http Request Type: POST
Request Body (data type: object)
Parameters
companyId (uuid)
to be provided by GoDocs
importDataList: (object[])
object based on schema as defined in the GoDocs Library
[optional] validateRequest (boolean)
default value: true
This allows import request to be validated or not.
Please note if validation is bypassed, unexpected behavior may occur. It is recommended that this field should be changed to false after development has been completed
Response Models
200
{
"data": [
{
"recordId": "c64d8af1-6129-4bd8-ad73-fcb229924442",
"errorMessages": null,
"data": {
"recordId": "c64d8af1-6129-4bd8-ad73-fcb229924442",
"referenceId": 12345,
"redirectUrl": "https://testing.godocs.com/login/sso/io/12345?username=[[username]]",
"summaryPageUrl": "https://app-sandbox-lds.godocs.com/Package/Summary/12345"
},
"success": true,
"message": null
}
],
"success": true,
"message": null
}
400
{
"data": [
{
"recordId": "93f565f6-8531-4075-b82a-a284fe02e352",
"errorMessages": [
"Required properties are missing from object: loanNumber. Path 'data.loan', line 1, position 106."
],
"data": "{\"importModelType\":\"test\"",
"success": false,
"message": "JSON Schema is invalid"
}
],
"success": false,
"message": "Import failed validation. Please resolve the issues"
}
500
{
"data": [
{
"recordId": "b09383a1-0c3e-471c-9b52-c757f12220b2",
"errorMessages": null,
"data": null,
"success": false,
"message": null
}
],
"success": false,
"message": "Error completing import. Please try again later."
}