v8
AutoCred Docs
Nigeria · v8 · OpenAPI 3.0.1

End-to-end credit data, from onboarding to SMARTScore

AutoCred lets authorized lenders and subscribers search Nigeria’s largest credit bureau, onboard and maintain customer records, and order credit reports in real time.

View integration flow
/nigeria/autocred/test/v8

AutoCred usage flow

A typical integration follows a repeatable pattern designed for security and data integrity:

  • Authenticate an agent and obtain a session code.
  • Search the bureau for an existing customer and capture their RegistryID.
  • Order credit reports and SMARTScores using that RegistryID.
  • Report and maintain your own portfolio data (persons, businesses, accounts).
HTTP/1.1

GET /nigeria/autocred/test/v8

Host: api.creditregistry.com

Content-Type: application/json

1. Auth & Session

Agents

Keep agent passwords current; login to obtain a Session Code.

/api/ResetPassword /api/Login

2. Search Customers

Customers

Locate customers by Name and BVN, Phone, RC Number or TaxID to get RegistryID.

/api/FindSummary /api/FindDetail

3. Get Reports

Reports

Retrieve data, scores, and PDFs using the RegistryID.

/api/GetReport201 /api/GetReport203

Agents & Auth

Manage credentials and sessions.

POST
/api/ResetPassword

Trigger a password reset (temporary password sent to agent's email address). Used when an agent has forgotten their password or for first-time setup.

POST
/api/UpdatePassword

Change the agent’s password (you need temporary password sent to agent's email address). On success, returns a LoginResponse with a new session code.

POST
/api/Login Core

Validate agent credentials and obtain the session code required for all other endpoints.

GET
/api/GetLoginTimeout

Check how much time remains on the current session code.

Login Logic

  1. Step 1

    Reset Password

    If expired/unknown, use ResetPassword then UpdatePassword.

  2. Step 2

    Authenticate

    Call /api/Login to get session code.

  3. Step 3

    Attach Header

    Include session code in subsequent JSON bodies.

Customers

Locate individuals and businesses.

POST
/api/FindSummary

Returns summary info (ID 8100) and RegistryID. Best for shortlists and pre-screening.

POST
/api/FindDetail

Returns detailed info (ID 8102) including the crucial RegistryID.

Why RegistryID?

The RegistryID returned in these searches is the identity key to an entity reported by a subscriber to CreditRegistry. Use it to:

  • Order credit reports and scores.
  • Link bureau records to your core banking or loan management system.

(Read the Data Quality Whitepaper to understand the purpose of the CorrelationID).

Reports & SMARTScores

Retrieve structured data and PDF files.

Endpoint Product
/api/GetReport200 Bureau Report
/api/GetReport201 Score Report
/api/GetReport202 Score Only
/api/GetReport203 Full Suite

Data Submission

Maintain Persons, Businesses & Accounts.

Persons

/api/AddUpdatePerson POST

Report or update individual. Returns UploadID.

/api/GetPersonUploadStatus POST

Track processing status.

Businesses

/api/AddUpdateBusiness POST

Report or update corporate entity.

Accounts

/api/AddUpdateAccount POST

Report loan/facility with owners & guarantors.

/api/AddUpdateAccountHistory POST

Correct payment history or balances.

/api/DissociateAccount POST

Unlink incorrect owners/guarantors.