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 8302 (i.e. SBCs + Account Summaries + Performance Summary).

POST
api.creditregistry.com/nigeria/AutoCred/test/v8/api/GetReport302
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/GetReport302' \
--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",
    "SBCs": [
        {
            "Registry_ID": "string",
            "Enquiry_Date": "2019-08-24T14:15:22Z",
            "VAR001": "string",
            "VAR002": "string",
            "VAR003": 0,
            "VAR004": "string",
            "VAR005a": "string",
            "VAR005b": "string",
            "VAR005c": "string",
            "VAR005d": "string",
            "VAR005e": "string",
            "VAR005f": "string",
            "VAR005g": "string",
            "VAR005h": "string",
            "VAR005i": "string",
            "VAR006a": "string",
            "VAR006b": "string",
            "VAR006c": "string",
            "VAR006d": "string",
            "VAR006e": "string",
            "VAR006f": "string",
            "VAR006g": "string",
            "VAR006h": "string",
            "VAR006i": "string",
            "VAR007a": "string",
            "VAR007b": "string",
            "VAR007c": "string",
            "VAR007d": "string",
            "VAR007e": "string",
            "VAR007f": "string",
            "VAR007g": "string",
            "VAR007h": "string",
            "VAR007i": "string",
            "VAR007j": "string",
            "VAR008a": "string",
            "VAR008b": "string",
            "VAR008c": "string",
            "VAR008d": "string",
            "VAR008e": "string",
            "VAR008f": "string",
            "VAR008g": "string",
            "VAR008h": "string",
            "VAR008i": "string",
            "VAR008j": "string",
            "VAR009a": "string",
            "VAR009b": "string",
            "VAR009c": "string",
            "VAR009d": "string",
            "VAR009e": "string",
            "VAR009f": "string",
            "VAR009g": "string",
            "VAR009h": "string",
            "VAR009i": "string",
            "VAR009j": "string",
            "VAR010a": "string",
            "VAR010b": "string",
            "VAR010c": "string",
            "VAR010d": "string",
            "VAR010e": "string",
            "VAR010f": "string",
            "VAR010g": "string",
            "VAR010h": "string",
            "VAR010i": "string",
            "VAR010j": "string",
            "VAR011a": "string",
            "VAR011b": "string",
            "VAR011c": "string",
            "VAR011d": "string",
            "VAR011e": "string",
            "VAR011f": "string",
            "VAR011g": "string",
            "VAR011h": "string",
            "VAR011i": "string",
            "VAR011j": "string",
            "VAR012a": "string",
            "VAR012b": "string",
            "VAR012c": "string",
            "VAR012d": "string",
            "VAR012e": "string",
            "VAR012f": "string",
            "VAR012g": "string",
            "VAR012h": "string",
            "VAR012i": "string",
            "VAR012j": "string",
            "VAR013a": "string",
            "VAR013b": "string",
            "VAR013c": "string",
            "VAR013d": "string",
            "VAR013e": "string",
            "VAR013f": "string",
            "VAR013g": "string",
            "VAR013h": "string",
            "VAR013i": "string",
            "VAR013j": "string",
            "VAR014a": "string",
            "VAR014b": "string",
            "VAR014c": "string",
            "VAR014d": "string",
            "VAR014e": "string",
            "VAR014f": "string",
            "VAR014g": "string",
            "VAR014h": "string",
            "VAR014i": "string",
            "VAR014j": "string",
            "VAR015a": "string",
            "VAR015b": "string",
            "VAR015c": "string",
            "VAR015d": "string",
            "VAR015e": "string",
            "VAR015f": "string",
            "VAR015g": "string",
            "VAR015h": "string",
            "VAR015i": "string",
            "VAR015j": "string",
            "VAR016": "string",
            "VAR017": "string",
            "VAR018": "string",
            "VAR019": "string",
            "VAR020a": 0,
            "VAR020b": 0,
            "VAR020c": 0,
            "VAR020d": 0,
            "VAR020e": 0,
            "VAR020f": 0,
            "VAR020g": 0,
            "VAR020h": 0,
            "VAR020i": 0,
            "VAR020j": 0,
            "VAR021a": 0,
            "VAR021b": 0,
            "VAR021c": 0,
            "VAR021d": 0,
            "VAR021e": 0,
            "VAR021f": 0,
            "VAR021g": 0,
            "VAR021h": 0,
            "VAR021i": 0,
            "VAR021j": 0,
            "VAR022": 0,
            "VAR023": 0,
            "VAR024a": "string",
            "VAR024b": "string",
            "VAR024c": "string",
            "VAR024d": "string",
            "VAR024e": "string",
            "VAR024f": "string",
            "VAR024g": "string",
            "VAR024h": "string",
            "VAR024i": "string",
            "VAR024j": "string",
            "VAR025a": "string",
            "VAR025b": "string",
            "VAR025c": "string",
            "VAR025d": "string",
            "VAR025e": "string",
            "VAR025f": "string",
            "VAR025g": "string",
            "VAR025h": "string",
            "VAR025i": "string",
            "VAR025j": "string",
            "VAR026a": "string",
            "VAR026b": "string",
            "VAR026c": "string",
            "VAR026d": "string",
            "VAR026e": "string",
            "VAR026f": "string",
            "VAR026g": "string",
            "VAR026h": "string",
            "VAR026i": "string",
            "VAR026j": "string",
            "VAR027a": "string",
            "VAR027b": "string",
            "VAR027c": "string",
            "VAR027d": "string",
            "VAR027e": "string",
            "VAR027f": "string",
            "VAR027g": "string",
            "VAR027h": "string",
            "VAR027i": "string",
            "VAR027j": "string",
            "VAR028a": "string",
            "VAR028b": "string",
            "VAR028c": "string",
            "VAR028d": "string",
            "VAR028e": "string",
            "VAR028f": "string",
            "VAR028g": "string",
            "VAR028h": "string",
            "VAR028i": "string",
            "VAR028j": "string",
            "VAR029": "string",
            "VAR030": "string",
            "VAR031": "string",
            "VAR032": "string",
            "VAR033": "string",
            "VAR034": "string",
            "VAR035": "string",
            "VAR036": "string",
            "VAR037": "string",
            "VAR038": "string",
            "VAR039": "string",
            "VAR040": 0,
            "VAR041": 0,
            "VAR042": 0,
            "VAR043": 0,
            "VAR044": 0,
            "VAR045": 0,
            "VAR046": 0,
            "VAR047": 0,
            "VAR048": "string",
            "VAR049": "string",
            "VAR050": "string",
            "VAR051": "string",
            "VAR052": "string",
            "VAR053": "string",
            "VAR054": "string",
            "VAR055": "string",
            "VAR056a": "string",
            "VAR056b": "string",
            "VAR056c": "string",
            "VAR057a": "string",
            "VAR057b": "string",
            "VAR057c": "string",
            "VAR058a": "string",
            "VAR058b": "string",
            "VAR058c": "string",
            "VAR059a": "string",
            "VAR059b": "string",
            "VAR059c": "string",
            "VAR060a": "string",
            "VAR060b": "string",
            "VAR060c": "string",
            "VAR061": "string",
            "VAR062": "string",
            "VAR063": "string",
            "VAR064": "string",
            "VAR065a": 0,
            "VAR065b": 0,
            "VAR065c": 0,
            "VAR066a": 0,
            "VAR066b": 0,
            "VAR066c": 0,
            "VAR067": 0,
            "VAR068": 0,
            "VAR069": "string",
            "VAR070": "string",
            "VAR071": "string",
            "VAR072": "string",
            "VAR073": "string",
            "VAR074": "string",
            "VAR075": "string",
            "VAR076": "string",
            "VAR077": "string",
            "VAR078": 0,
            "VAR079": 0,
            "VAR080": 0,
            "VAR081": 0,
            "VAR082": 0,
            "VAR083": 0,
            "VAR084": 0,
            "VAR085": 0,
            "VAR086": "string",
            "VAR087": "string",
            "VAR088": 0,
            "VAR089": "string",
            "VAR090": 0,
            "VAR091": "string",
            "VAR092": "string",
            "VAR093": 0,
            "VAR094": 0,
            "VAR095": "string",
            "VAR096": "string",
            "VAR097": "string",
            "VAR098": 0,
            "VAR099": 0,
            "VAR100": "string",
            "VAR101a": "string",
            "VAR101b": "string",
            "VAR101c": "string",
            "VAR101d": "string",
            "VAR101e": "string",
            "VAR101f": "string",
            "VAR101g": "string",
            "VAR101h": "string",
            "VAR101i": "string",
            "VAR102a": "string",
            "VAR102b": "string",
            "VAR102c": "string",
            "VAR102d": "string",
            "VAR102e": "string"
        }
    ],
    "AccountSummaries": [
        {
            "Currency": "string",
            "Count_Revolving": 0,
            "Balance_Revolving": 0,
            "CreditLimit_Revolving": 0,
            "Payment_Revolving": 0,
            "Count_Auto": 0,
            "Balance_Auto": 0,
            "CreditLimit_Auto": 0,
            "Payment_Auto": 0,
            "Count_Installment": 0,
            "Balance_Installment": 0,
            "CreditLimit_Installment": 0,
            "Payment_Installment": 0,
            "Count_Mortgage": 0,
            "Balance_Mortgage": 0,
            "CreditLimit_Mortgage": 0,
            "Payment_Mortgage": 0,
            "Count_Overdraft": 0,
            "Balance_Overdraft": 0,
            "CreditLimit_Overdraft": 0,
            "Minimum_Payment": 0,
            "Count_Other": 0,
            "Balance_Other": 0,
            "CreditLimit_Other": 0,
            "Payment_Other": 0,
            "Balance_Total": 0,
            "Count_Total": 0,
            "CreditLimit_Total": 0,
            "Payment_Total": 0
        }
    ],
    "PerformanceSummary": {
        "Inquiry_Count_12_Months": "string",
        "Count_AccountStatus_Closed": "string",
        "Count_AccountStatus_Delinquent_30_over_60_days": "string",
        "Count_AccountStatus_Derogatory_Doubtful_180": "string",
        "Count_AccountStatus_Derogatory_Lost_360": "string",
        "Count_AccountStatus_Derogatory_Substandard_90": "string",
        "Count_AccountStatus_Late_less_than_30_days": "string",
        "Count_AccountStatus_Open": "string",
        "Count_AccountStatus_Performing": "string",
        "Count_AccountStatus_Unknown": "string",
        "Count_AccountStatus_Unspecified": "string",
        "Count_AccountStatus_Written_off": "string",
        "Count_LegalStatus_Judgment": "string",
        "Count_LegalStatus_Litigation": "string",
        "Count_LegalStatus_Notice": "string",
        "Count_LegalStatus_Receivership": "string",
        "SectorExclusionCount": 0,
        "SectorExclusionMessage": "string"
    }
}
Modified at 2025-11-29 04:37:26
Previous
Returns data for product ID 8301 (i.e. credit performance check to determine whether or not a customer is "performing").
Next
Returns data for product ID 8303 (i.e. SBCs + Account Summaries + Performance Summary + Account data).
Built with