How to Use AutoCred8 API

AutoCred API v8
  1. Accounts
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.
      POST
    • Get a business/corporate customer record you uploaded to CreditRegistry.
      POST
    • Gets status of an upload using the UploadID value returned from a successful data submission API call.
      POST
  • Persons
    • Reports your person/individual account owners to CreditRegistry.
      POST
    • Get a person/individual customer record you uploaded to CreditRegistry.
      POST
    • Gets status of an upload using the UploadID value returned from a successful data submission API call.
      POST
  • 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. Accounts

Reports an account (or loan record from your organization) to CreditRegistry.

POST
api.creditregistry.com/nigeria/AutoCred/test/v8/api/AddUpdateAccount
Accounts

At least one account owner is required for an account. Guarantors are optional.

Specify complete account owner information via Request.Account.IndividualAccountOwners and/or
Request.Account.BusinessAccountOwners. Alternately, for account owners that your organization has
previously reported to CreditRegistry, specify their customer numbers via
Request.Account.AccountOwnerCustomerNumbers.

If the account or loan has guarantors, specify complete guarantor information via
Request.Account.IndividualGuarantors and/or Request.Account.BusinessGuarantors. Alternately,
for guarantors that your organization has previously reported to CreditRegistry, specify their
customer numbers via Request.Account.GuarantorCustomerNumbers.

Whenever customer numbers of account owners or guarantors are specified, persons or businesses with
the given customer numbers must already exist at CreditRegistry otherwise the upload is rejected.
If uncertain, specify complete account owner and guarantor information instead.

If the specified account information, account owners or guarantors already exist they are UPDATED.

To dissociate account owners or guarantors from an account, use the DissociateAccount endpoint.

If the request passes validation, it is queued for processing and Response.Success will be true;
otherwise, the request is rejected, Response.Success will be false, and Response.Errors will
contain reasons for the rejection.

Use Response.UploadID, with the GetAccountUploadStatus endpoint to query the status of this request.

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/AddUpdateAccount' \
--header 'Content-Type: application/json' \
--data-raw '{
    "SessionCode": "string",
    "Account": {
        "AccountNumber": "string",
        "AccountStatus": "Performing",
        "AccountStatusDate": "2019-08-24T14:15:22Z",
        "Balance": 0,
        "DaysInArrears": 0,
        "BalanceDate": "2019-08-24T14:15:22Z",
        "Payment": 0,
        "PaymentDate": "2019-08-24T14:15:22Z",
        "CreditorNotes": "string",
        "AccountNotes": "string",
        "LegalStatus": "None",
        "LegalStatusDate": "2019-08-24T14:15:22Z",
        "DateOpened": "2019-08-24T14:15:22Z",
        "LoanPrincipalCreditLimit": 0,
        "MinimumInstallment": 0,
        "CurrencyType": "A00",
        "AccountType": "AA00_InvalidAccountType",
        "Term": "string",
        "Purpose": "string",
        "RepaymentFrequency": "Daily",
        "MaturityDate": "2019-08-24T14:15:22Z",
        "BranchName": "string",
        "BranchAddress": "string",
        "SortCode": "string",
        "InterestType": "Fixed",
        "InterestRate": 0,
        "IndividualAccountOwners": [
            {
                "StreetAddress1": "string",
                "StreetAddress2": "string",
                "City": "string",
                "StateProvince": "string",
                "ZipPostalCode": "string",
                "LGA": "string",
                "Country": "string",
                "ContactPhoneNumbers": [
                    "string"
                ],
                "OfficePhoneNumbers": [
                    "string"
                ],
                "FaxNumbers": [
                    "string"
                ],
                "ContactEmailAddresses": [
                    "string"
                ],
                "OfficeEmailAddresses": [
                    "string"
                ],
                "CustomerNumber": "string",
                "FirstName": "string",
                "Surname": "string",
                "OtherNames": [
                    "string"
                ],
                "DateOfBirth": "2019-08-24T14:15:22Z",
                "BVN": "string",
                "NationalID": "string",
                "DriverLicenseNo": "string",
                "TaxID": "string",
                "PassportNo": "string",
                "VoterID": "string",
                "Gender": "Female",
                "MaritalStatus": "Single",
                "AccommodationStatus": "Rent",
                "MonthlyRentMortgage": 0,
                "EmploymentStatus": "Unemployed",
                "AnnualIncome": 0,
                "AssetValue": 0,
                "EducationLevel": "Unknown",
                "CountryOfNationality": "A0_InvalidCountry",
                "NumberOfDependants": 0,
                "Pictures": [
                    {
                        "PictureBase64String": "string",
                        "PictureFormat": "JPEG"
                    }
                ],
                "Employments": [
                    {
                        "StreetAddress1": "string",
                        "StreetAddress2": "string",
                        "City": "string",
                        "StateProvince": "string",
                        "ZipPostalCode": "string",
                        "LGA": "string",
                        "Country": "string",
                        "Employer": "string",
                        "JobTitle": "string",
                        "Occupation": "string",
                        "Manager": "string",
                        "StartDate": "2019-08-24T14:15:22Z",
                        "EndDate": "2019-08-24T14:15:22Z",
                        "AnnualIncome": 0
                    }
                ]
            }
        ],
        "IndividualGuarantors": [
            {
                "StreetAddress1": "string",
                "StreetAddress2": "string",
                "City": "string",
                "StateProvince": "string",
                "ZipPostalCode": "string",
                "LGA": "string",
                "Country": "string",
                "ContactPhoneNumbers": [
                    "string"
                ],
                "OfficePhoneNumbers": [
                    "string"
                ],
                "FaxNumbers": [
                    "string"
                ],
                "ContactEmailAddresses": [
                    "string"
                ],
                "OfficeEmailAddresses": [
                    "string"
                ],
                "CustomerNumber": "string",
                "FirstName": "string",
                "Surname": "string",
                "OtherNames": [
                    "string"
                ],
                "DateOfBirth": "2019-08-24T14:15:22Z",
                "BVN": "string",
                "NationalID": "string",
                "DriverLicenseNo": "string",
                "TaxID": "string",
                "PassportNo": "string",
                "VoterID": "string",
                "Gender": "Female",
                "MaritalStatus": "Single",
                "AccommodationStatus": "Rent",
                "MonthlyRentMortgage": 0,
                "EmploymentStatus": "Unemployed",
                "AnnualIncome": 0,
                "AssetValue": 0,
                "EducationLevel": "Unknown",
                "CountryOfNationality": "A0_InvalidCountry",
                "NumberOfDependants": 0,
                "Pictures": [
                    {
                        "PictureBase64String": "string",
                        "PictureFormat": "JPEG"
                    }
                ],
                "Employments": [
                    {
                        "StreetAddress1": "string",
                        "StreetAddress2": "string",
                        "City": "string",
                        "StateProvince": "string",
                        "ZipPostalCode": "string",
                        "LGA": "string",
                        "Country": "string",
                        "Employer": "string",
                        "JobTitle": "string",
                        "Occupation": "string",
                        "Manager": "string",
                        "StartDate": "2019-08-24T14:15:22Z",
                        "EndDate": "2019-08-24T14:15:22Z",
                        "AnnualIncome": 0
                    }
                ]
            }
        ],
        "BusinessAccountOwners": [
            {
                "StreetAddress1": "string",
                "StreetAddress2": "string",
                "City": "string",
                "StateProvince": "string",
                "ZipPostalCode": "string",
                "LGA": "string",
                "Country": "string",
                "ContactPhoneNumbers": [
                    "string"
                ],
                "OfficePhoneNumbers": [
                    "string"
                ],
                "FaxNumbers": [
                    "string"
                ],
                "ContactEmailAddresses": [
                    "string"
                ],
                "OfficeEmailAddresses": [
                    "string"
                ],
                "CustomerNumber": "string",
                "Name": "string",
                "RCNumber": "string",
                "TaxID": "string",
                "DateOfIncorporation": "2019-08-24T14:15:22Z",
                "AnnualRevenue": 0,
                "AssetValue": 0,
                "Website": "string",
                "TypeOfBusiness": "CommercialBank",
                "CorporateOfficers": [
                    {
                        "StreetAddress1": "string",
                        "StreetAddress2": "string",
                        "City": "string",
                        "StateProvince": "string",
                        "ZipPostalCode": "string",
                        "LGA": "string",
                        "Country": "string",
                        "ContactPhoneNumbers": [
                            "string"
                        ],
                        "OfficePhoneNumbers": [
                            "string"
                        ],
                        "FaxNumbers": [
                            "string"
                        ],
                        "ContactEmailAddresses": [
                            "string"
                        ],
                        "OfficeEmailAddresses": [
                            "string"
                        ],
                        "CustomerNumber": "string",
                        "FirstName": "string",
                        "Surname": "string",
                        "OtherNames": [
                            "string"
                        ],
                        "DateOfBirth": "2019-08-24T14:15:22Z",
                        "BVN": "string",
                        "NationalID": "string",
                        "DriverLicenseNo": "string",
                        "TaxID": "string",
                        "PassportNo": "string",
                        "VoterID": "string",
                        "Gender": "Female",
                        "MaritalStatus": "Single",
                        "AccommodationStatus": "Rent",
                        "MonthlyRentMortgage": 0,
                        "EmploymentStatus": "Unemployed",
                        "AnnualIncome": 0,
                        "AssetValue": 0,
                        "EducationLevel": "Unknown",
                        "CountryOfNationality": "A0_InvalidCountry",
                        "NumberOfDependants": 0,
                        "Pictures": [
                            {
                                "PictureBase64String": "string",
                                "PictureFormat": "JPEG"
                            }
                        ],
                        "Employments": [
                            {
                                "StreetAddress1": "string",
                                "StreetAddress2": "string",
                                "City": "string",
                                "StateProvince": "string",
                                "ZipPostalCode": "string",
                                "LGA": "string",
                                "Country": "string",
                                "Employer": "string",
                                "JobTitle": "string",
                                "Occupation": "string",
                                "Manager": "string",
                                "StartDate": "2019-08-24T14:15:22Z",
                                "EndDate": "2019-08-24T14:15:22Z",
                                "AnnualIncome": 0
                            }
                        ],
                        "CorporateOfficerType": "Officer",
                        "CorporateOfficerJobPositionTitle": "string",
                        "StartDate": "2019-08-24T14:15:22Z",
                        "EndDate": "2019-08-24T14:15:22Z"
                    }
                ]
            }
        ],
        "BusinessGuarantors": [
            {
                "StreetAddress1": "string",
                "StreetAddress2": "string",
                "City": "string",
                "StateProvince": "string",
                "ZipPostalCode": "string",
                "LGA": "string",
                "Country": "string",
                "ContactPhoneNumbers": [
                    "string"
                ],
                "OfficePhoneNumbers": [
                    "string"
                ],
                "FaxNumbers": [
                    "string"
                ],
                "ContactEmailAddresses": [
                    "string"
                ],
                "OfficeEmailAddresses": [
                    "string"
                ],
                "CustomerNumber": "string",
                "Name": "string",
                "RCNumber": "string",
                "TaxID": "string",
                "DateOfIncorporation": "2019-08-24T14:15:22Z",
                "AnnualRevenue": 0,
                "AssetValue": 0,
                "Website": "string",
                "TypeOfBusiness": "CommercialBank",
                "CorporateOfficers": [
                    {
                        "StreetAddress1": "string",
                        "StreetAddress2": "string",
                        "City": "string",
                        "StateProvince": "string",
                        "ZipPostalCode": "string",
                        "LGA": "string",
                        "Country": "string",
                        "ContactPhoneNumbers": [
                            "string"
                        ],
                        "OfficePhoneNumbers": [
                            "string"
                        ],
                        "FaxNumbers": [
                            "string"
                        ],
                        "ContactEmailAddresses": [
                            "string"
                        ],
                        "OfficeEmailAddresses": [
                            "string"
                        ],
                        "CustomerNumber": "string",
                        "FirstName": "string",
                        "Surname": "string",
                        "OtherNames": [
                            "string"
                        ],
                        "DateOfBirth": "2019-08-24T14:15:22Z",
                        "BVN": "string",
                        "NationalID": "string",
                        "DriverLicenseNo": "string",
                        "TaxID": "string",
                        "PassportNo": "string",
                        "VoterID": "string",
                        "Gender": "Female",
                        "MaritalStatus": "Single",
                        "AccommodationStatus": "Rent",
                        "MonthlyRentMortgage": 0,
                        "EmploymentStatus": "Unemployed",
                        "AnnualIncome": 0,
                        "AssetValue": 0,
                        "EducationLevel": "Unknown",
                        "CountryOfNationality": "A0_InvalidCountry",
                        "NumberOfDependants": 0,
                        "Pictures": [
                            {
                                "PictureBase64String": "string",
                                "PictureFormat": "JPEG"
                            }
                        ],
                        "Employments": [
                            {
                                "StreetAddress1": "string",
                                "StreetAddress2": "string",
                                "City": "string",
                                "StateProvince": "string",
                                "ZipPostalCode": "string",
                                "LGA": "string",
                                "Country": "string",
                                "Employer": "string",
                                "JobTitle": "string",
                                "Occupation": "string",
                                "Manager": "string",
                                "StartDate": "2019-08-24T14:15:22Z",
                                "EndDate": "2019-08-24T14:15:22Z",
                                "AnnualIncome": 0
                            }
                        ],
                        "CorporateOfficerType": "Officer",
                        "CorporateOfficerJobPositionTitle": "string",
                        "StartDate": "2019-08-24T14:15:22Z",
                        "EndDate": "2019-08-24T14:15:22Z"
                    }
                ]
            }
        ],
        "AccountOwnerCustomerNumbers": [
            "string"
        ],
        "GuarantorCustomerNumbers": [
            "string"
        ],
        "AccountHistory": [
            {
                "AccountNumber": "string",
                "AccountStatus": "Performing",
                "AccountStatusDate": "2019-08-24T14:15:22Z",
                "Balance": 0,
                "DaysInArrears": 0,
                "BalanceDate": "2019-08-24T14:15:22Z",
                "Payment": 0,
                "PaymentDate": "2019-08-24T14:15:22Z",
                "CreditorNotes": "string",
                "AccountNotes": "string",
                "LegalStatus": "None",
                "LegalStatusDate": "2019-08-24T14:15:22Z",
                "AccountHistoryID": "string",
                "SubscriberID": "string"
            }
        ],
        "Collaterals": [
            {
                "Collateral": "string",
                "CollateralType": "None",
                "CollateralValue": 0,
                "CollateralCurrency": "A00",
                "CollateralDate": "2019-08-24T14:15:22Z"
            }
        ],
        "AccountHistoryID": "string",
        "SubscriberID": "string"
    }
}'
Response Response Example
{
    "Success": true,
    "Errors": [
        "string"
    ],
    "StatusCode": 0,
    "Message": "string",
    "UploadID": "string",
    "UploadDate": "2019-08-24T14:15:22Z",
    "UploadType": "PersonAddUpdate",
    "UploadTypeDescription": "string",
    "AgentID": "string",
    "SubscriberID": "string",
    "UploadStatusList": [
        {
            "TransactionID": "string",
            "TransactionDate": "2019-08-24T14:15:22Z",
            "ProcessingStatus": "UploadReceived",
            "ProcessingStatusDescription": "string",
            "ProcessingStatusMessage": "string",
            "ProcessingMessages": [
                "string"
            ]
        }
    ]
}
Modified at 2025-11-29 04:37:26
Previous
Returns data for product ID 8102 (i.e. detailed customer information using specified search parameters).
Next
Updates or corrects account history record at CreditRegistry.
Built with