How to Use AutoCred8 API

AutoCred API v8
  1. Reports
AutoCred API v8
  • Agents
    • Login and get session code to use for subsequent API calls.
      POST
    • Logout of the session with the specified session code.
      POST
    • Reset password for agent with specified details.
      POST
    • Update password for agent with specified details.
      POST
    • Get login timeout (session codes become invalid after this period).
      GET
  • Customers
    • Returns data for product ID 8100 (i.e. summary customer information using specified search parameters).
      POST
    • Returns data for product ID 8102 (i.e. detailed customer information using specified search parameters).
      POST
  • Accounts
    • Reports an account (or loan record from your organization) to CreditRegistry.
      POST
    • Updates or corrects account history record at CreditRegistry.
      POST
    • Deletes wrong or invalid account history records at CreditRegistry.
      POST
    • Dissociates account owner(s) and/or guarantors from an account.
      POST
    • Gets an account (or loan record for your organization) from CreditRegistry.
      POST
    • Gets status of an upload using the UploadID value returned from a successful data submission API call.
      POST
  • Businesses
    • Reports your business/corporate account owners to CreditRegistry.
    • Get a business/corporate customer record you uploaded to CreditRegistry.
    • Gets status of an upload using the UploadID value returned from a successful data submission API call.
  • Persons
    • Reports your person/individual account owners to CreditRegistry.
    • Get a person/individual customer record you uploaded to CreditRegistry.
    • Gets status of an upload using the UploadID value returned from a successful data submission API call.
  • Reports
    • Returns data for product ID 8200 (i.e. Account data + PDF Report).
      POST
    • Returns data for product ID 8201 (i.e. Account data + SMARTScore + Score Factor).
      POST
    • Returns data for product ID 8202 (i.e. SMARTScore + Score Factor).
      POST
    • Returns data for product ID 8203 (i.e. Account data + SMARTScore + Score Factor + PDF Report).
      POST
    • Returns data for product ID 8204 (i.e. Account data).
      POST
    • Returns data for product ID 8300 (i.e. PDF Report).
      POST
    • Returns data for product ID 8301 (i.e. credit performance check to determine whether or not a customer is "performing").
      POST
    • Returns data for product ID 8302 (i.e. SBCs + Account Summaries + Performance Summary).
      POST
    • Returns data for product ID 8303 (i.e. SBCs + Account Summaries + Performance Summary + Account data).
      POST
    • Returns data for product ID 8304 (i.e. SBCs + Account Summaries + Performance Summary + SMARTScore + Score Factor).
      POST
    • Returns data for product ID 8305 (i.e. SBCs + Account Summaries + Performance Summary + Account data + SMARTScore + Score Factor).
      POST
    • Returns data for product ID 8306 (i.e. SBCs + Account Summaries + Performance Summary + SMARTScore + Score Factor + PDF Report).
      POST
    • Returns data for product ID 8400 (i.e. customer payment profile which indicates payment performance over the previous months).
      POST
  • Schemas
    • AccommodationStatus
    • AccountDataResult
    • AccountHistoryBaseReq
    • AccountHistoryIdentity
    • AccountHistoryUpdateReq
    • AccountStatus
    • AccountSummaryByCurrencyResult
    • AccountType
    • AddUpdateAccountHistoryRequest
    • AddUpdateAccountRequest
    • AddUpdateBusinessRequest
    • AddUpdatePersonRequest
    • BaseResponse
    • BusinessType
    • BusinessWithRelationReq
    • ClosedAccountsResult
    • Collateral
    • CollateralAccountHistoryBase
    • CollateralCollateralAccountHistoryBasePicturePicturePersonBusinessWithRelationReqAccount
    • CollateralReq
    • CollateralReqAccountHistoryBaseReqAccountReq
    • CollateralType
    • CorporateOfficerReq
    • CorporateOfficerType
    • CountryCode
    • CreditorsResult
    • CurrencyType
    • CustomerDetail
    • CustomerPaymentProfile
    • CustomerPerformance
    • CustomerSummary
    • DeleteAccountHistoryRequest
    • DelinquentAccountsResult
    • DerogatoryAccountsResult
    • DissociateAccountRequest
    • EducationLevel
    • Employment
    • EmploymentStatus
    • EnquiryReason
    • FamilyRelationReq
    • FamilyRelationType
    • FindDetailRequest
    • FindDetailResponse
    • FindSummaryRequest
    • FindSummaryResponse
    • Gender
    • GetAccountRequest
    • GetAccountResponse
    • GetBusinessRequest
    • GetPersonRequest
    • GetReport200Request
    • GetReport200Response
    • GetReport201Request
    • GetReport201Response
    • GetReport202Request
    • GetReport202Response
    • GetReport203Request
    • GetReport203Response
    • GetReport204Request
    • GetReport204Response
    • GetReport300Request
    • GetReport300Response
    • GetReport301Request
    • GetReport301Response
    • GetReport302Request
    • GetReport302Response
    • GetReport303Request
    • GetReport303Response
    • GetReport304Request
    • GetReport304Response
    • GetReport305Request
    • GetReport305Response
    • GetReport306Request
    • GetReport306Response
    • GetReport400Request
    • GetReport400Response
    • InquiryHistoryResult
    • InquiryHistorySummaryResult
    • InterestType
    • LegalStatus
    • LoginRequest
    • LoginResponse
    • LogoutRequest
    • MaritalStatus
    • NoMatchReportSetting
    • PaymentProfileCustomer
    • PaymentProfileInfo
    • PerformanceSummaryResult
    • PerformingAccountsResult
    • PersonReq
    • PersonWithRelationReq
    • Picture
    • PictureCorporateOfficer
    • PictureFamilyRelation
    • PictureFormat
    • PicturePerson
    • PicturePictureCorporateOfficerBusinessWithRelation
    • PicturePictureCorporateOfficerBusinessWithRelationGetBusinessResponse
    • PicturePictureFamilyRelationRelatedBusinessPersonWithRelation
    • PicturePictureFamilyRelationRelatedBusinessPersonWithRelationGetPersonResponse
    • PictureReq
    • ProcessingStatus
    • RelatedBusiness
    • RelatedBusinessReq
    • RepaymentFrequencyType
    • ResetPasswordRequest
    • SBCResult
    • SMARTScoreResult
    • ScoreFactorResult
    • UnknownStatusAccountsResult
    • UpdatePasswordRequest
    • UploadResponse
    • UploadStatus
    • UploadStatusRequest
    • UploadStatusResponse
    • UploadType
    • WrittenOffAccountsResult
  1. Reports

Returns data for product ID 8201 (i.e. Account data + SMARTScore + Score Factor).

POST
api.creditregistry.com/nigeria/AutoCred/test/v8/api/GetReport201
Reports

Request

Body Params application/json

Examples

Responses

🟢200OK
application/json
Request was processed.
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'api.creditregistry.com/nigeria/AutoCred/test/v8/api/GetReport201' \
--header 'Content-Type: application/json' \
--data-raw '{
    "SessionCode": "string",
    "CustomerRegistryIDList": [
        "string"
    ],
    "EnquiryReason": "KYCCheck",
    "HistoryLengthInMonths": 0
}'
Response Response Example
{
    "Success": true,
    "Errors": [
        "string"
    ],
    "InfoMessage": "string",
    "TransactionID": "string",
    "AccountData": {
        "PerformingAccounts": [
            {
                "PaymentProfile": "string",
                "Creditor_Registry_ID": "string",
                "Account_No": "string",
                "Abbreviated_Account_No": "string",
                "Account_Owners": "string",
                "Guarantors": "string",
                "Date_Opened": "2019-08-24T14:15:22Z",
                "Account_Status_ID": 0,
                "Date_First_Reported": "2019-08-24T14:15:22Z",
                "Credit_Limit": 0,
                "Balance": 0,
                "Minimum_Installment": 0,
                "Account_Type": "string",
                "Term": "string",
                "Purpose": "string",
                "Account_Owner_Notes": "string",
                "Creditor_Notes": "string",
                "Collateral": "string",
                "Collateral_Value": 0,
                "Legal_Status_ID": 0,
                "Legal_Status_Date": "2019-08-24T14:15:22Z",
                "LastUpdatedBy": "string",
                "LastUpdated": "2019-08-24T14:15:22Z",
                "Unique_ID": "string",
                "Account_Status_Date": "2019-08-24T14:15:22Z",
                "Payment": 0,
                "Payment_Date": "2019-08-24T14:15:22Z",
                "Balance_Date": "2019-08-24T14:15:22Z",
                "Term_Frequency": "string",
                "State_Change_Date": "2019-08-24T14:15:22Z",
                "Account_Type_Description": "string",
                "Currency": "string",
                "Collateral_Currency": "string",
                "CreditorName": "string",
                "CreditorAddress": "string",
                "CreditorCity": "string",
                "CreditorState": "string",
                "CreditorFullAddress": "string",
                "Legal_Status": "string",
                "Account_Status": "string",
                "Subscriber_Type_ID": "string",
                "Delinquency_Statements": "string"
            }
        ],
        "DelinquentAccounts": [
            {
                "PaymentProfile": "string",
                "Creditor_Registry_ID": "string",
                "Account_No": "string",
                "Abbreviated_Account_No": "string",
                "Account_Owners": "string",
                "Guarantors": "string",
                "Date_Opened": "2019-08-24T14:15:22Z",
                "Account_Status_ID": 0,
                "Date_First_Reported": "2019-08-24T14:15:22Z",
                "Credit_Limit": 0,
                "Balance": 0,
                "Minimum_Installment": 0,
                "Account_Type": "string",
                "Term": "string",
                "Purpose": "string",
                "Account_Owner_Notes": "string",
                "Creditor_Notes": "string",
                "Collateral": "string",
                "Collateral_Value": 0,
                "Legal_Status_ID": 0,
                "Legal_Status_Date": "2019-08-24T14:15:22Z",
                "LastUpdatedBy": "string",
                "LastUpdated": "2019-08-24T14:15:22Z",
                "Unique_ID": "string",
                "Account_Status_Date": "2019-08-24T14:15:22Z",
                "Payment": 0,
                "Payment_Date": "2019-08-24T14:15:22Z",
                "Balance_Date": "2019-08-24T14:15:22Z",
                "Term_Frequency": "string",
                "State_Change_Date": "2019-08-24T14:15:22Z",
                "Account_Type_Description": "string",
                "Currency": "string",
                "Collateral_Currency": "string",
                "CreditorName": "string",
                "CreditorAddress": "string",
                "CreditorCity": "string",
                "CreditorState": "string",
                "CreditorFullAddress": "string",
                "Legal_Status": "string",
                "Account_Status": "string",
                "Subscriber_Type_ID": "string",
                "Delinquency_Statements": "string"
            }
        ],
        "ClosedAccounts": [
            {
                "PaymentProfile": "string",
                "Creditor_Registry_ID": "string",
                "Account_No": "string",
                "Abbreviated_Account_No": "string",
                "Account_Owners": "string",
                "Guarantors": "string",
                "Date_Opened": "2019-08-24T14:15:22Z",
                "Account_Status_ID": 0,
                "Date_First_Reported": "2019-08-24T14:15:22Z",
                "Credit_Limit": 0,
                "Balance": 0,
                "Minimum_Installment": 0,
                "Account_Type": "string",
                "Term": "string",
                "Purpose": "string",
                "Account_Owner_Notes": "string",
                "Creditor_Notes": "string",
                "Collateral": "string",
                "Collateral_Value": 0,
                "Legal_Status_ID": 0,
                "Legal_Status_Date": "2019-08-24T14:15:22Z",
                "LastUpdatedBy": "string",
                "LastUpdated": "2019-08-24T14:15:22Z",
                "Unique_ID": "string",
                "Account_Status_Date": "2019-08-24T14:15:22Z",
                "Payment": 0,
                "Payment_Date": "2019-08-24T14:15:22Z",
                "Balance_Date": "2019-08-24T14:15:22Z",
                "Term_Frequency": "string",
                "State_Change_Date": "2019-08-24T14:15:22Z",
                "Account_Type_Description": "string",
                "Currency": "string",
                "Collateral_Currency": "string",
                "CreditorName": "string",
                "CreditorAddress": "string",
                "CreditorCity": "string",
                "CreditorState": "string",
                "CreditorFullAddress": "string",
                "Legal_Status": "string",
                "Account_Status": "string",
                "Subscriber_Type_ID": "string",
                "Delinquency_Statements": "string"
            }
        ],
        "DerogatoryAccounts": [
            {
                "PaymentProfile": "string",
                "Creditor_Registry_ID": "string",
                "Account_No": "string",
                "Abbreviated_Account_No": "string",
                "Account_Owners": "string",
                "Guarantors": "string",
                "Date_Opened": "2019-08-24T14:15:22Z",
                "Account_Status_ID": 0,
                "Date_First_Reported": "2019-08-24T14:15:22Z",
                "Credit_Limit": 0,
                "Balance": 0,
                "Minimum_Installment": 0,
                "Account_Type": "string",
                "Term": "string",
                "Purpose": "string",
                "Account_Owner_Notes": "string",
                "Creditor_Notes": "string",
                "Collateral": "string",
                "Collateral_Value": 0,
                "Legal_Status_ID": 0,
                "Legal_Status_Date": "2019-08-24T14:15:22Z",
                "LastUpdatedBy": "string",
                "LastUpdated": "2019-08-24T14:15:22Z",
                "Unique_ID": "string",
                "Account_Status_Date": "2019-08-24T14:15:22Z",
                "Payment": 0,
                "Payment_Date": "2019-08-24T14:15:22Z",
                "Balance_Date": "2019-08-24T14:15:22Z",
                "Term_Frequency": "string",
                "State_Change_Date": "2019-08-24T14:15:22Z",
                "Account_Type_Description": "string",
                "Currency": "string",
                "Collateral_Currency": "string",
                "CreditorName": "string",
                "CreditorAddress": "string",
                "CreditorCity": "string",
                "CreditorState": "string",
                "CreditorFullAddress": "string",
                "Legal_Status": "string",
                "Account_Status": "string",
                "Subscriber_Type_ID": "string",
                "Delinquency_Statements": "string"
            }
        ],
        "WrittenOffAccounts": [
            {
                "PaymentProfile": "string",
                "Creditor_Registry_ID": "string",
                "Account_No": "string",
                "Abbreviated_Account_No": "string",
                "Account_Owners": "string",
                "Guarantors": "string",
                "Date_Opened": "2019-08-24T14:15:22Z",
                "Account_Status_ID": 0,
                "Date_First_Reported": "2019-08-24T14:15:22Z",
                "Credit_Limit": 0,
                "Balance": 0,
                "Minimum_Installment": 0,
                "Account_Type": "string",
                "Term": "string",
                "Purpose": "string",
                "Account_Owner_Notes": "string",
                "Creditor_Notes": "string",
                "Collateral": "string",
                "Collateral_Value": 0,
                "Legal_Status_ID": 0,
                "Legal_Status_Date": "2019-08-24T14:15:22Z",
                "LastUpdatedBy": "string",
                "LastUpdated": "2019-08-24T14:15:22Z",
                "Unique_ID": "string",
                "Account_Status_Date": "2019-08-24T14:15:22Z",
                "Payment": 0,
                "Payment_Date": "2019-08-24T14:15:22Z",
                "Balance_Date": "2019-08-24T14:15:22Z",
                "Term_Frequency": "string",
                "State_Change_Date": "2019-08-24T14:15:22Z",
                "Account_Type_Description": "string",
                "Currency": "string",
                "Collateral_Currency": "string",
                "CreditorName": "string",
                "CreditorAddress": "string",
                "CreditorCity": "string",
                "CreditorState": "string",
                "CreditorFullAddress": "string",
                "Legal_Status": "string",
                "Account_Status": "string",
                "Subscriber_Type_ID": "string",
                "Delinquency_Statements": "string"
            }
        ],
        "UnknownStatusAccounts": [
            {
                "PaymentProfile": "string",
                "Creditor_Registry_ID": "string",
                "Account_No": "string",
                "Abbreviated_Account_No": "string",
                "Account_Owners": "string",
                "Guarantors": "string",
                "Date_Opened": "2019-08-24T14:15:22Z",
                "Account_Status_ID": 0,
                "Date_First_Reported": "2019-08-24T14:15:22Z",
                "Credit_Limit": 0,
                "Balance": 0,
                "Minimum_Installment": 0,
                "Account_Type": "string",
                "Term": "string",
                "Purpose": "string",
                "Account_Owner_Notes": "string",
                "Creditor_Notes": "string",
                "Collateral": "string",
                "Collateral_Value": 0,
                "Legal_Status_ID": 0,
                "Legal_Status_Date": "2019-08-24T14:15:22Z",
                "LastUpdatedBy": "string",
                "LastUpdated": "2019-08-24T14:15:22Z",
                "Unique_ID": "string",
                "Account_Status_Date": "2019-08-24T14:15:22Z",
                "Payment": 0,
                "Payment_Date": "2019-08-24T14:15:22Z",
                "Balance_Date": "2019-08-24T14:15:22Z",
                "Term_Frequency": "string",
                "State_Change_Date": "2019-08-24T14:15:22Z",
                "Account_Type_Description": "string",
                "Currency": "string",
                "Collateral_Currency": "string",
                "CreditorName": "string",
                "CreditorAddress": "string",
                "CreditorCity": "string",
                "CreditorState": "string",
                "CreditorFullAddress": "string",
                "Legal_Status": "string",
                "Account_Status": "string",
                "Subscriber_Type_ID": "string",
                "Delinquency_Statements": "string"
            }
        ],
        "InquiryHistory": [
            {
                "Subscriber_ID": "string",
                "Subscriber": "string",
                "ContactPhone": "string",
                "Reason": "string",
                "InquiryDate": "2019-08-24T14:15:22Z"
            }
        ],
        "InquiryHistorySummary": {
            "Last3MonthCount": "string",
            "Last12MonthCount": "string",
            "Last36MonthCount": "string"
        },
        "Creditors": [
            {
                "Subscriber_ID": "string",
                "Name": "string",
                "Phone": "string",
                "Address": "string"
            }
        ]
    },
    "SMARTScores": [
        {
            "RegistryID": "string",
            "GenericScore": 0
        }
    ],
    "ScoreFactors": [
        {
            "RegistryID": "string",
            "ScoreFactorType": "string",
            "ScoreFactorNarrative": "string"
        }
    ]
}
Modified at 2025-11-29 04:37:26
Previous
Returns data for product ID 8200 (i.e. Account data + PDF Report).
Next
Returns data for product ID 8202 (i.e. SMARTScore + Score Factor).
Built with