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

    GetReport200Response

    Returned on success by the GetReport200() API. NOTE: if you
    pass a registry ID that is not found in CreditRegistry, there
    will be no entry for it in the various search results within
    the response.

    {
        "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"
                }
            ]
        },
        "Reports": [
            {
                "Success": true,
                "Errors": [
                    "string"
                ],
                "InfoMessage": "string",
                "TransactionID": "string",
                "ReportNo": "string",
                "FileName": "string",
                "PDFContent": "string"
            }
        ]
    }
    Built with