尼日利亚信用报告 V1.0

尼日利亚信用报告，返回客户基本信息和历史征信情况；包含异步查询提交接口、异步结果推送接口和兜底结果查询接口。

第一步：异步查询提交

API方式

Base URL

尼日利亚：https://ng-credit.apitd.net/credit/data/creditreport/v1

API

请求方式	Content-Type	输出格式	字符集
POST	application/json	Json	UTF-8

认证参数

字段	类型	建议	备注
partner_code	String	必须	合作⽅标识，由TD提供
partner_key	String	必须	合作⽅标识，由TD提供

请求参数

字段	类型	建议	备注
id_number	String	必须	身份证件号。尼日利亚地区：bvn
id_type	String	必须	身份证类型。尼日利亚地区："bvn"
country	String	必须	两位国家码，符合 ISO 3166 标准。尼日利亚地区："NG"
phone_number	String	必须	手机号，不带国家码
name	String	必须	姓名
ext	Object	非必需	自定义内容，不超过1KB

请求示例

{
	"id_number": "22370756505",
	"id_type": "bvn",
	"country": "NG",
	"phone_number": "9981234567",
	"name": "Amlodd Adisa"
}

响应参数

字段	类型	含义	备注
code	Integer	API 状态码
message	String	状态信息	在 API 异常状态下会输出具体的异常原因
sequence_id	String	响应唯一码	用于跟踪每次请求记录的唯一标识

API状态码

code	Message	含义
200		成功
300	Service not purchased or not effective	服务不可⽤
301	Service not purchased	服务未购买
302	Service has been suspend	服务已被禁⽤
303	Not enough balance	流量不足
304	Service expired	服务已过期
9500	Internal error	内部错误
9060	{parameter} empty	{字段名}为空
9061	{parameter} error	{字段名}错误

通过上述接口传输数据给到TD后，TD 将返回的收入数据通过本 API 推送给您。

第二步：异步结果推送

API 方式

Base URL

您提供给 TD 的订阅 API 地址。请您在配置时联系运营同事，我们将为您配置。

注：回调地址支持http 80端口以及https的443端口

API

URL	请求方式	Content-Type	输出格式	字符集
api-base-url?partner_code=xxx×tamp=xxx&access_key=xxx&sign=xxx	POST	application/json	JSON	UTF-8

认证参数

字段	类型	含义	建议	备注
partner_code	String	合作方标识	必须	由 TD 分配
timestamp	String	当前时间戳	必须	毫秒级
access_key	String	access key	必须	由 TD 分配
sign	String	签名	必须

sign 生成方式:

sign = HmacSHA1(partner_code+timestamp+access_key,access_secret)

其中 access_secret 由 TD 分配

Headers

参数名	参数值	建议
Content-Type	application/json	必须

推送请求参数

字段	类型	含义
result	String	命中：hit 未命中：no_record 错误：error
code	Integer	状态码
message	String	状态信息
sequence_id	String	用于跟踪每次请求记录的唯一标识
data	Object	报告细节，仅命中时展示
ext	Object	自定义内容，同入参内容，仅有入参时展示

Obj##### code与message枚举值

Code	Message	含义
200		查询成功
9500	Service unavailable, please retry later	服务不可用，请稍后重试

data包含字段与含义

报告模块	字段	含义
report_detail_bvn	cir_number	报告唯一编号
	report_order_date	报告请求日期
	institution_name	授权机构名称
	bvn_number	银行验证码(BVN)
	search_confidence_score	置信分
inquiry_product	bank	银行
	micro	小额信贷银行
	mortgage	抵押银行
	nbfc	非银行金融公司
	other	其他机构
	total	总数
	product_type	产品类别
classification_prod_type	currency	货币
	no_acc_last_six_mon	过去6个月内为这产品类型的设施总数
	no_of_accounts	过去24个月内为这产品类型的设施总数
	recent_overdue_date	在设施上的最近逾期日期
	product_type	产品类别
	sanctioned_amount	设施核准的总金额
	total_outstanding_balance	设施类型的未结余额总数
	amount_overdue	贷款逾期金额
inquiry_history_details	facility_type	设施类型
	inquiry_date	调用日期
	institution_type	机构类型
	sno	编号
classification_ins_type	currency	货币
	institution_type	机构类型
	no_of_accounts	设施总数
	oustanding_balance	分组机构的未清余额总数
	approved_credit_sanctioned	设施核准的总金额
	amount_overdue	贷款逾期金额
conscomm_details - conscomm_details_id	identifier_number	身份证件号码
	id_type	身份证件类型
conscomm_details - conscomm_details_subject	address	地址
	application_viability_score	应用程序可行性分数
	date_of_birth	生日(DD-Mon-YYYY)
	date_of_birth_m	生日(YYYY-MM-DD)
	gender	性别
	name	姓名
	nationality	国籍
	phone_no1	手机号

响应示例

命中

{
	"sequence_id": "1699272744735016i303341798930550",
	"code": 200,
	"message": "success",
	"result": "hit",
	"data": {
		"report_detail_bvn": {
			"report_order_date": "24-aug-2023",
			"search_confidence_score": "100%",
			"cir_number": "w-0087662519/2023",
			"institution_name": "finnew fintech limited",
			"bvn_number": 22366507571
		},
		"inquiry_product": [{
			"other": "0",
			"total": "6",
			"product_type": "asset acquisition loan",
			"bank": "0",
			"nbfc": "0",
			"mortgage": "0",
			"micro": "6"
		},
		{
			"other": "1",
			"total": "5",
			"product_type": "overdraft",
			"bank": "0",
			"nbfc": "0",
			"mortgage": "0",
			"micro": "4"
		},
		{
			"other": "1",
			"total": "11",
			"product_type": "total",
			"bank": "0",
			"nbfc": "0",
			"mortgage": "0",
			"micro": "10"
		}],
		"classification_prod_type": [{
			"currency": "ngn",
			"product_type": "term loan",
			"recent_overdue_date": "31-jul-2023",
			"no_acc_last_six_mon": "1",
			"amount_overdue": "139,691",
			"sanctioned_amount": "155,000",
			"no_of_accounts": "5",
			"total_outstanding_balance": "139,691"
		}],
		"inquiry_history_details": [{
			"institution_type": "micro lenders",
			"sno": "1",
			"facility_type": "overdraft",
			"inquiry_date": "18-may-2023"
		},
		{
			"institution_type": "other organizations",
			"sno": "2",
			"facility_type": "overdraft",
			"inquiry_date": "17-may-2023"
		},
		{
			"institution_type": "micro lenders",
			"sno": "3",
			"facility_type": "overdraft",
			"inquiry_date": "13-may-2023"
		},
		{
			"institution_type": "micro lenders",
			"sno": "4",
			"facility_type": "overdraft",
			"inquiry_date": "04-may-2023"
		},
		{
			"institution_type": "micro lenders",
			"sno": "5",
			"facility_type": "asset acquisition loan",
			"inquiry_date": "07-mar-2023"
		},
		{
			"institution_type": "micro lenders",
			"sno": "6",
			"facility_type": "asset acquisition loan",
			"inquiry_date": "13-feb-2023"
		},
		{
			"institution_type": "micro lenders",
			"sno": "7",
			"facility_type": "overdraft",
			"inquiry_date": "06-feb-2023"
		},
		{
			"institution_type": "micro lenders",
			"sno": "8",
			"facility_type": "asset acquisition loan",
			"inquiry_date": "15-oct-2022"
		},
		{
			"institution_type": "micro lenders",
			"sno": "9",
			"facility_type": "asset acquisition loan",
			"inquiry_date": "28-sep-2022"
		},
		{
			"institution_type": "micro lenders",
			"sno": "10",
			"facility_type": "asset acquisition loan",
			"inquiry_date": "17-sep-2022"
		},
		{
			"institution_type": "micro lenders",
			"sno": "11",
			"facility_type": "asset acquisition loan",
			"inquiry_date": "17-sep-2022"
		},
		{
			"institution_type": "micro lenders",
			"sno": "12",
			"facility_type": "asset acquisition loan",
			"inquiry_date": "26-jan-2022"
		}],
		"classification_ins_type": [{
			"currency": "ngn",
			"institution_type": "micro lenders",
			"amount_overdue": "139,691",
			"oustanding_balance": "139,691",
			"approved_credit_sanctioned": "155,000",
			"no_of_accounts": "5"
		}],
		"conscomm_details": {
			"conscomm_details_id": [{
				"identifier_number": "22366507571",
				"id_type": "bank verification number"
			}],
			"conscomm_details_subject": {
				"nationality": "nigeria",
				"application_viability_score": "na",
				"address": "not available 025 ng lagos nigeria ",
				"date_of_birth_m": "1999-06-05",
				"gender": "male",
				"phone_no1": "9026061222",
				"date_of_birth": "05-jun-1999",
				"name": "okechukwu uzodinma akubueze"
			}
		}
	}
}

未命中

{
	"sequence_id": "1699272744735016i303341798930550",
	"code": 200,
	"message": "success",
	"result": "no_record"
}

响应参数

您的业务系统在收到推送请求后需要响应的参数

字段	类型	含义	建议	备注
code	Integer	API 状态码	必须
message	String	状态信息	必须	在 API 异常状态下会输出具体的异常原因

API 状态码

code	含义
200	成功

响应示例

{
  "code": 200,
  "message": ""
}

说明：若您返回的状态码非 200，我们会重试 3 次，3 次均失败则不会再推送。但您可以通过下述查询接口进行查询。

兜底结果查询

如您长时间未收到返回数据推送，可通过本查询接口传入第一步调用返回的sequence_id进行结果的查询。本接口仅支持24h内的结果查询。
注：该接口为异步查询的兜底接口，配置异步接口后成功调用但无返回的情况下可通过该接口查询，有限流机制，请勿重复查询

API方式

Base URL

尼日利亚：https://ng-credit.apitd.net/credit/data/creditreport/query/v1

API

请求方式	Content-Type	输出格式	字符集
POST	application/json	Json	UTF-8

认证参数

字段	类型	建议	备注
partner_code	String	必须	合作⽅标识，由TD提供
partner_key	String	必须	合作⽅标识，由TD提供

请求参数

字段	类型	建议	备注
sequence_id	String	必须	第一步调用返回的sequence_id

返回参数

与上述推送请求参数保持一致。可参考文档推送请求参数 部分内容

API 状态码

code	Message	含义
200		成功
9060	{parameter} empty	{字段名}为空
9080	Only queries within 24 hours are available	超时无法查询
9083	There was an error occurred, please try again	发生错误，请重试
9084	Work in progress	报告正在获取中，请稍后再试
9500	Internal error	服务不可用，请稍后再试

响应示例（成功）

同上述异步结果推送接口。可参考响应示例部分内容

响应示例（失败）

{
    "code": 9080,
    "message": "Only queries within 48 hours are available.",
    "sequence_id": "1703123181798646G109E3248****377"
}