CreditReportService

Import or order a credit report.

Symitar eDocs References: Coming soon.

Operations

orderReport

Orders a credit report.

POSThttps://naas.ymcu.libum.io/nexum/627/2022.01/creditreport/orderReport

Authorization

bearerAuth

Body

application/json

Credentials*object

The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.

Bureaustring

AccountNumberstring

SSNstring

Nameobject

Addressobject

Experianobject

ChexSystemsobject

nxAttributes*object

The custom object for NexumAPI request attributes.

Response

200

Successful operation.

Body

application/json

Statusobject

CredRepLocatorinteger

Request

JavaScriptCurlPython

const response = await fetch('https://naas.ymcu.libum.io/nexum/627/2022.01/creditreport/orderReport', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Credentials": {
        "AdministrativeCredentials": {
          "Password": "suwn37834b91&"
        }
      },
      "nxAttributes": {
        "customFields": {
          "appId": "glaci"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "Status": {
    "StatusCode": 0,
    "Message": "text"
  },
  "CredRepLocator": 0
}

importReport

Imports a credit report.

POSThttps://naas.ymcu.libum.io/nexum/627/2022.01/creditreport/importReport

Authorization

bearerAuth

Body

application/json

Credentials*object

The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.

Bureaustring

AccountNumberstring

FileNamestring

PrimaryMemberobject

JointMemberobject

ECOAInquiryTypestring

nxAttributes*object

The custom object for NexumAPI request attributes.

Response

200

Successful operation.

Body

application/json

Statusobject

CredRepLocatorinteger

Request

JavaScriptCurlPython

const response = await fetch('https://naas.ymcu.libum.io/nexum/627/2022.01/creditreport/importReport', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Credentials": {
        "AdministrativeCredentials": {
          "Password": "suwn37834b91&"
        }
      },
      "nxAttributes": {
        "customFields": {
          "appId": "glaci"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "Status": {
    "StatusCode": 0,
    "Message": "text"
  },
  "CredRepLocator": 0
}