Get Credit Status


Description

This method is used to search by debtor's uuid or account number and retrieve debtor's uuid , companyName, creditStatus.

Authentication

Requires HTTP BASIC authentication.

HTTP Methods

Accepts GET requests.

URI

/api/debtors/{id}/credit_status.json

Path Variables

Name Required/Optional Description Validation
id required The UUID of the Debtor in the system or account number Debtor UUID should exist in the system.

Parameters

Name Required/Optional Description Validation
creditor optional The UUID of the creditor to run the credit status as You will receive a an HTTP 400 if the UUID is invalid and you will receive a 404 if the UUID doesn't belong to a valid creditor.

Curl Example

Request

curl -u apiuser:test "https://www.factorsnetwork.com/api/debtors/768ab42b-acd4-7df8-b124-90d062371ce3/credit_status.json"

Response

{
  "creditStatusResponse" : {
    "uuid" : "768ab42b-acd4-7df8-b124-90d062371ce3",
    "companyName" : "COMPANY NAME",
    "creditorDebtorOverrideStatus" : "DENIED",
    "countryDebtorOverrideStatus" : null,
    "noteTypeStatus" : "DENIED",
    "debtorMcNumbersFinalStatus" : "APPROVED",
    "monthsForShortTerm" : 6,
    "monthsForLongTerm" : 12,
    "creditScoreDenied" : "0-57",
    "creditScoreReview" : "58-71",
    "creditScoreApproved" : "72-100",
    "creditScoreActual" : 95,
    "creditScoreStatus" : "APPROVED",
    "avgDaysToPayDenied" : "0-57",
    "avgDaysToPayReview" : "58-71",
    "avgDaysToPayApproved" : "72-100",
    "avgDaysToPayActual" : 95,
    "avgDaysToPayStatus" : "APPROVED",
    "minimumBalanceDenied" : "$0-$999",
    "minimumBalanceReview" : "$1,000+",
    "minimumBalanceApproved" : null,
    "minimumBalanceActual" : "$10,570",
    "minimumBalanceStatus" : "REVIEW_REQUIRED",
    "minimumCreditorUploadsDenied" : null,
    "minimumCreditorUploadsReview" : null,
    "minimumCreditorUploadsApproved" : "2-6",
    "minimumCreditorUploadsActual" : 13,
    "minimumCreditorUploadsStatus" : "APPROVED",
    "minimumMonthsDenied" : "0-5",
    "minimumMonthsReview" : null,
    "minimumMonthsApproved" : "6-24",
    "minimumMonthsActual" : 12,
    "minimumMonthsStatus" : "APPROVED",
    "percentageBalanceFor45DaysDeniedInShortTerm" : "30-100",
    "percentageBalanceFor45DaysReviewInShortTerm" : "15-29",
    "percentageBalanceFor45DaysApprovedInShortTerm" : "0-14",
    "percentageBalanceFor45DaysActualInShortTerm" : 6,
    "percentageBalanceFor45DaysStatusInShortTerm" : "APPROVED",
    "percentageBalanceFor45DaysDeniedInLongTerm" : "10-100",
    "percentageBalanceFor45DaysReviewInLongTerm" : "5-9",
    "percentageBalanceFor45DaysApprovedInLongTerm" : "0-4",
    "percentageBalanceFor45DaysActualInLongTerm" : 4,
    "percentageBalanceFor45DaysStatusInLongTerm" : "APPROVED",
    "creditorsForShortTermDenied" : "0-1",
    "creditorsForShortTermReview" : null,
    "creditorsForShortTermApproved" : "2-6",
    "creditorsForShortTermActual" : 11,
    "creditorsForShortTermStatus" : "APPROVED",
    "creditorsForLongTermDenied" : "0-3",
    "creditorsForLongTermReview" : null,
    "creditorsForLongTermApproved" : "4-6",
    "creditorsForLongTermActual" : 13,
    "creditorsForLongTermStatus" : "APPROVED",
    "brokerAuthorityHistoryStatus" : [ {
      "mcNumber" : 103798,
      "dotNumber" : 8987655,
      "brokerAuthorityHistoryStatusDenied" : "0-4",
      "brokerAuthorityHistoryStatusReview" : "5-9",
      "brokerAuthorityHistoryStatusApproved" : "10-24",
      "orginalActionMonth" : 309,
      "brokerAuthorityHistoryCreditStatus" : "APPROVED"
    }],
    "inActiveBrokerAuthorityStatus" : [ {
      "mcNumber" : 103798,
      "dotNumber" : 8987655,
      "status" : "REVIEW_REQUIRED"
    }],
    "inActiveBrokerAuthorityFinalStatus" : "REVIEW_REQUIRED",
    "brokerAuthorityHistoryFinalStatus" : "APPROVED",
    "dataCheckStatus" : null,
    "creditStatus" : "DENIED"
  }
}

Request

curl -u apiuser:test "https://www.factorsnetwork.com/api/debtors/MAR421/credit_status.json"

Response

{
  "creditStatusResponse" : {
    "uuid" : "768ab42b-acd4-7df8-b124-90d062371ce3",
    "companyName" : "COMPANY NAME",
    "creditorDebtorOverrideStatus" : "DENIED",
    "countryDebtorOverrideStatus" : null,
    "noteTypeStatus" : "DENIED",
    "debtorMcNumbersFinalStatus" : "APPROVED",
    "monthsForShortTerm" : 6,
    "monthsForLongTerm" : 12,
    "creditScoreDenied" : "0-57",
    "creditScoreReview" : "58-71",
    "creditScoreApproved" : "72-100",
    "creditScoreActual" : 95,
    "creditScoreStatus" : "APPROVED",
    "avgDaysToPayDenied" : "0-57",
    "avgDaysToPayReview" : "58-71",
    "avgDaysToPayApproved" : "72-100",
    "avgDaysToPayActual" : 95,
    "avgDaysToPayStatus" : "APPROVED",
    "minimumBalanceDenied" : "$0-$999",
    "minimumBalanceReview" : "$1,000+",
    "minimumBalanceApproved" : null,
    "minimumBalanceActual" : "$10,570",
    "minimumBalanceStatus" : "REVIEW_REQUIRED",
    "minimumCreditorUploadsDenied" : null,
    "minimumCreditorUploadsReview" : null,
    "minimumCreditorUploadsApproved" : "2-6",
    "minimumCreditorUploadsActual" : 13,
    "minimumCreditorUploadsStatus" : "APPROVED",
    "minimumMonthsDenied" : "0-5",
    "minimumMonthsReview" : null,
    "minimumMonthsApproved" : "6-24",
    "minimumMonthsActual" : 12,
    "minimumMonthsStatus" : "APPROVED",
    "percentageBalanceFor45DaysDeniedInShortTerm" : "30-100",
    "percentageBalanceFor45DaysReviewInShortTerm" : "15-29",
    "percentageBalanceFor45DaysApprovedInShortTerm" : "0-14",
    "percentageBalanceFor45DaysActualInShortTerm" : 6,
    "percentageBalanceFor45DaysStatusInShortTerm" : "APPROVED"
    "percentageBalanceFor45DaysDeniedInLongTerm" : "10-100",
    "percentageBalanceFor45DaysReviewInLongTerm" : "5-9",
    "percentageBalanceFor45DaysApprovedInLongTerm" : "0-4",
    "percentageBalanceFor45DaysActualInLongTerm" : 4,
    "percentageBalanceFor45DaysStatusInLongTerm" : "APPROVED",
    "creditorsForShortTermDenied" : "0-1",
    "creditorsForShortTermReview" : null,
    "creditorsForShortTermApproved" : "2-6",
    "creditorsForShortTermActual" : 11,
    "creditorsForShortTermStatus" : "APPROVED",
    "creditorsForLongTermDenied" : "0-3",
    "creditorsForLongTermReview" : null,
    "creditorsForLongTermApproved" : "4-6",
    "creditorsForLongTermActual" : 13,
    "creditorsForLongTermStatus" : "APPROVED",
    "brokerAuthorityHistoryStatus" : [ {
      "mcNumber" : 103798,
      "dotNumber" : 786565,
      "brokerAuthorityHistoryStatusDenied" : "0-4",
      "brokerAuthorityHistoryStatusReview" : "5-9",
      "brokerAuthorityHistoryStatusApproved" : "10-24",
      "orginalActionMonth" : 309,
      "brokerAuthorityHistoryCreditStatus" : "APPROVED"
    }],
    "brokerAuthorityHistoryFinalStatus" : "APPROVED",
    "inActiveBrokerAuthorityStatus" : [ {
      "mcNumber" : 103798,
      "dotNumber" : 786565,
      "status" : "REVIEW_REQUIRED"
    }],
    "inActiveBrokerAuthorityFinalStatus" : "REVIEW_REQUIRED",
    "dataCheckStatus" : null,
    "creditStatus" : "DENIED"
  }
}

Note: Responses will not be pretty printed when using the API, but have been formatted here for documentation purposes.