How to Use AutoCred8 API

AutoCred API v8
    AutoCred API v8
    • Agents
      • Login and get session code to use for subsequent API calls.
      • Logout of the session with the specified session code.
      • Reset password for agent with specified details.
      • Update password for agent with specified details.
      • Get login timeout (session codes become invalid after this period).
    • Customers
      • Returns data for product ID 8100 (i.e. summary customer information using specified search parameters).
      • Returns data for product ID 8102 (i.e. detailed customer information using specified search parameters).
    • Accounts
      • Reports an account (or loan record from your organization) to CreditRegistry.
      • Updates or corrects account history record at CreditRegistry.
      • Deletes wrong or invalid account history records at CreditRegistry.
      • Dissociates account owner(s) and/or guarantors from an account.
      • Gets an account (or loan record for your organization) from CreditRegistry.
      • Gets status of an upload using the UploadID value returned from a successful data submission API call.
    • 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).
      • Returns data for product ID 8201 (i.e. Account data + SMARTScore + Score Factor).
      • Returns data for product ID 8202 (i.e. SMARTScore + Score Factor).
      • Returns data for product ID 8203 (i.e. Account data + SMARTScore + Score Factor + PDF Report).
      • Returns data for product ID 8204 (i.e. Account data).
      • Returns data for product ID 8300 (i.e. PDF Report).
      • Returns data for product ID 8301 (i.e. credit performance check to determine whether or not a customer is "performing").
      • Returns data for product ID 8302 (i.e. SBCs + Account Summaries + Performance Summary).
      • Returns data for product ID 8303 (i.e. SBCs + Account Summaries + Performance Summary + Account data).
      • Returns data for product ID 8304 (i.e. SBCs + Account Summaries + Performance Summary + SMARTScore + Score Factor).
      • Returns data for product ID 8305 (i.e. SBCs + Account Summaries + Performance Summary + Account data + SMARTScore + Score Factor).
      • Returns data for product ID 8306 (i.e. SBCs + Account Summaries + Performance Summary + SMARTScore + Score Factor + PDF Report).
      • Returns data for product ID 8400 (i.e. customer payment profile which indicates payment performance over the previous months).
    • 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

    PicturePictureFamilyRelationRelatedBusinessPersonWithRelationGetPersonResponse

    Response for Persons.Get.

    {
        "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"
                }
            ]
        }
    }
    Built with