Credit Bureau Reports

post

The Business Credit and Compliance Report API provides detailed reports on a company's financial, legal, and compliance information. It includes company registration details, credit history, principal relationships, court judgments, defaults, and SME risk assessments, making it ideal for evaluating creditworthiness, legal standing, and financial stability. This API is useful for due diligence, risk assessment, and KYC/KYB processes.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
registration_nostringOptional

Company registration number. format: 2060/119044/01.

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us.

Responses
200Success
application/json
post
/api/v2/commercial/transunionreport
post

This endpoint retrieves a detailed consumer credit report for a specified individual. The report includes personal information, address history, telephone history, employment records, credit account histories (Evolution records), credit summaries, enquiries, personal loan scorecard information, and additional resources like a PDF version of the report and a link to the detailed report.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body

Schema representing a request for a consumer's credit report, including necessary personal identification details.

id_numberstringOptional

South African identification number of the consumer.

first_namestringOptional

First name of the consumer.

middle_namestringOptional

Middle name of the consumer.

last_namestringOptional

Last name (surname) of the consumer.

Responses
200Success
application/json
post
/api/v2/consumer/transunionreport
post

Transunion credit report for business about credit activity and current credit situation such as loan paying history and the status credit accounts. If the ITNumber is unknown, we recommend calling the POST /api/commercial/businesssearch operation first.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
ITNumberstringOptional

Business ITNumber, This Number is provided by TransUnion and must be used to pull the full Credit Report

EnquiryReasonstringOptional

Enquiry reason; CreditRisk, CreditLimitManagement, Other, CreditInformationQuery, Employment, Tracing, Affordability, InternalEnquiry, PrescreeningMarketing, InternationalEnquiry, AccessCheck, InsuranceApplication, SettingLimit, UnclaimedFundsDistribution, AffordabilityAssessment, ModelDevelopment, Contactibility, CreditScoringModel, CreditInformationQuery, DebtCounseling, TracingByCreditProvider, FraudCorruptionTheftInv, FraudDetectionFraudPrev or DebtorBookAssessment

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/commercial/transunionreport
post

Transunion credit PDF report for businesses about credit activity and current credit situation such as loan paying history and the status credit accounts. If the ITNumber is unknown, we recommend calling the POST /api/commercial/businesssearch operation first.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
ITNumberstringOptional

ITNumber, This Number is provided by TransUnion and must be used to pull the full Credit Report

EnquiryReasonstringOptional

Enquiry reason

EnquirerNamestringOptional

Enquirer name

EnquirerEmaistringOptional

Enquirer email

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/commercial/transunionreportpdf
post

Transunion credit report for consumers about credit activity and current credit situation such as loan paying history and the status credit accounts.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
EnquirerContactNamestringOptional

Enquire contact name

EnquirerContactPhoneNostringOptional

Enquirer contact phone number

EnquiryTypestringOptional

Enquiry type

Forename1stringOptional

Customer forename1

SurnamestringOptional

Customer surname

Forename2stringOptional

Customer forename2

IdentityNo1stringOptional

Customer ID number

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/consumer/transunionreport
post

Transunion credit PDF report for consumers about credit activity and current credit situation such as loan paying history and the status credit accounts.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
EnquirerContactNamestringOptional

Enquirer contact name)

EnquirerContactPhoneNostringOptional

Enquirer contact phone number

EnquiryTypestringOptional

Enquiry type: CreditRisk, CreditLimitManagement, Other, CreditInformationQuery, Employment, Tracing, Affordability, InternalEnquiry, PrescreeningMarketing, InternationalEnquiry, AccessCheck, InsuranceApplication, SettingLimit, UnclaimedFundsDistribution, AffordabilityAssessment, ModelDevelopment, Contactibility, CreditScoringModel, CreditInformationQuery, DebtCounseling, TracingByCreditProvider, FraudCorruptionTheftInv, FraudDetectionFraudPrev or DebtorBookAssessment

SurnamestringOptional

Consumer surname

Forename1stringOptional

Consumer Forename1

Forename2stringOptional

Consumer Forename2

BirthDatestringOptional

Consumer date of birth

IdentityNo1stringOptional

Consumer ID number

SexstringOptional

Consumer sex: M for Male, F for Female

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/consumer/transunionreportpdf
post

Retrieve commercial credit information from TransUnion Credit Bureau by ITNumber. (Second Call)

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
ITNumberstringOptional

This Number is provided by TransUnion and must be used to pull the full Credit Report. It can be optained from complaince.transunionVerification API call

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us.

Responses
200Success
application/json
post
/api/transunionreport
post

Retrieve commercial credit information from TransUnion Credit Bureau for verification and background checks, typically used in initial credit evaluations.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
company_reg_numberstringOptional

company's registration number, which is typically issued during the registration process (eg 201623389407)

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/v2/transunionverification
post

Initiate commercial credit information request from TransUnion Credit Bureau. (First Call)

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
company_reg_numberstringOptional

company's registration number, which is typically issued during the registration process (eg 201623389407)

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/transunionverification
post

Experian credit report for consumers about credit activity and current credit situation such as loan paying history and the status credit accounts.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

Consumer ID number

first_namesstringOptional

Consumer full names

surnamestringOptional

Consumer surname

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/consumerexperianreport
post

Express Consumer Credit Score, providing a quick overview of an individual’s creditworthiness based on their credit history and current financial situation.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

South African ID number

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/expresscreditscore

Last updated