How to Use AutoCred8 API

AutoCred API v8
  1. Persons
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. Persons

Get a person/individual customer record you uploaded to CreditRegistry.

POST
api.creditregistry.com/nigeria/AutoCred/test/v8/api/GetPerson
Persons

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/GetPerson' \
--header 'Content-Type: application/json' \
--data-raw '{
    "SessionCode": "string",
    "CustomerNumber": "string",
    "RegistryID": "string",
    "GetFamilyRelations": true,
    "GetRelatedBusinesses": true
}'
Response Response Example
{
    "Success": true,
    "Errors": [
        "string"
    ],
    "StatusCode": 0,
    "Message": "string",
    "Person": {
        "IsInCompleteAddress": true,
        "StreetAddress1": "string",
        "StreetAddress2": "string",
        "City": "string",
        "StateProvince": "string",
        "ZipPostalCode": "string",
        "LGA": "string",
        "Country": "string",
        "ContactPhoneNumbers": [
            "string"
        ],
        "OfficePhoneNumbers": [
            "string"
        ],
        "FaxNumbers": [
            "string"
        ],
        "ContactEmailAddresses": [
            "string"
        ],
        "OfficeEmailAddresses": [
            "string"
        ],
        "IsContactInfoEmpty": true,
        "IsContactPhoneNumberEmpty": true,
        "IsOfficePhoneNumberEmpty": true,
        "IsContactEmailAddressEmpty": true,
        "IsOfficeEmailAddressEmpty": true,
        "Name": "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",
        "GenderDescription": "string",
        "MaritalStatus": "Single",
        "MaritalStatusDescription": "string",
        "AccommodationStatus": "Rent",
        "AccommodationStatusDescription": "string",
        "MonthlyRentMortgage": 0,
        "EmploymentStatus": "Unemployed",
        "EmploymentStatusDescription": "string",
        "AnnualIncome": 0,
        "AssetValue": 0,
        "EducationLevel": "Unknown",
        "EducationLevelDescription": "string",
        "CountryOfNationality": "A0_InvalidCountry",
        "CountryOfNationalityDescription": "string",
        "NumberOfDependants": 0,
        "Pictures": [
            {
                "PictureFormatDescription": "string",
                "PictureBase64String": "string",
                "PictureFormat": "JPEG"
            }
        ],
        "Employments": [
            {
                "IsInCompleteAddress": true,
                "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
            }
        ],
        "RelatedBusinesses": [
            {
                "IsInCompleteAddress": true,
                "StreetAddress1": "string",
                "StreetAddress2": "string",
                "City": "string",
                "StateProvince": "string",
                "ZipPostalCode": "string",
                "LGA": "string",
                "Country": "string",
                "ContactPhoneNumbers": [
                    "string"
                ],
                "OfficePhoneNumbers": [
                    "string"
                ],
                "FaxNumbers": [
                    "string"
                ],
                "ContactEmailAddresses": [
                    "string"
                ],
                "OfficeEmailAddresses": [
                    "string"
                ],
                "IsContactInfoEmpty": true,
                "IsContactPhoneNumberEmpty": true,
                "IsOfficePhoneNumberEmpty": true,
                "IsContactEmailAddressEmpty": true,
                "IsOfficeEmailAddressEmpty": true,
                "CustomerNumber": "string",
                "Name": "string",
                "RCNumber": "string",
                "TaxID": "string",
                "DateOfIncorporation": "2019-08-24T14:15:22Z",
                "AnnualRevenue": 0,
                "AssetValue": 0,
                "Website": "string",
                "TypeOfBusiness": "CommercialBank",
                "TypeOfBusinessDescription": "string",
                "RelationshipTypeDescription": "string",
                "RelationshipType": "Officer",
                "JobPositionTitle": "string",
                "StartDate": "2019-08-24T14:15:22Z",
                "EndDate": "2019-08-24T14:15:22Z"
            }
        ],
        "FamilyRelations": [
            {
                "IsInCompleteAddress": true,
                "StreetAddress1": "string",
                "StreetAddress2": "string",
                "City": "string",
                "StateProvince": "string",
                "ZipPostalCode": "string",
                "LGA": "string",
                "Country": "string",
                "ContactPhoneNumbers": [
                    "string"
                ],
                "OfficePhoneNumbers": [
                    "string"
                ],
                "FaxNumbers": [
                    "string"
                ],
                "ContactEmailAddresses": [
                    "string"
                ],
                "OfficeEmailAddresses": [
                    "string"
                ],
                "IsContactInfoEmpty": true,
                "IsContactPhoneNumberEmpty": true,
                "IsOfficePhoneNumberEmpty": true,
                "IsContactEmailAddressEmpty": true,
                "IsOfficeEmailAddressEmpty": true,
                "Name": "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",
                "GenderDescription": "string",
                "MaritalStatus": "Single",
                "MaritalStatusDescription": "string",
                "AccommodationStatus": "Rent",
                "AccommodationStatusDescription": "string",
                "MonthlyRentMortgage": 0,
                "EmploymentStatus": "Unemployed",
                "EmploymentStatusDescription": "string",
                "AnnualIncome": 0,
                "AssetValue": 0,
                "EducationLevel": "Unknown",
                "EducationLevelDescription": "string",
                "CountryOfNationality": "A0_InvalidCountry",
                "CountryOfNationalityDescription": "string",
                "NumberOfDependants": 0,
                "Pictures": [
                    {
                        "PictureFormatDescription": "string",
                        "PictureBase64String": "string",
                        "PictureFormat": "JPEG"
                    }
                ],
                "Employments": [
                    {
                        "IsInCompleteAddress": true,
                        "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
                    }
                ],
                "FamilyRelationType": "Spouse",
                "FamilyRelationTypeDescription": "string"
            }
        ]
    }
}
Modified at 2025-11-29 04:37:26
Previous
Reports your person/individual account owners to CreditRegistry.
Next
Gets status of an upload using the UploadID value returned from a successful data submission API call.
Built with