企业接口文档

企业接口文档,易背调提供给企业使用的API


实体关系和最佳实践

实体关系

调查项

调查项指某种调查/核实内容,如 身份信息核实、公共负面信息查询、法院诉讼查询 等

套餐

套餐由"调查项"组合而成,1个套餐包含 n(n≥1)项"调查项",每个企业可定制自己的套餐

订单

订单是用户进行单次背调服务的最小单位,由 n(n≥1)个"背调"组成

> 订单状态包括:-10:已取消;30:待支付;40:进行中;50:已完成 > 订单创建后状态是[待支付];支付后状态将流转为[进行中]并开启关联的"背调"状态流转;所有关联的"背调"完成[状态为已取消/已出报告],则该订单状态自动更新为[已完成]

背调

背调由 n(n≥1)个"背调调查项"组成,关联在[订单]下,每个背调包含一个实际需要被背调的候选人信息,如 姓名、身份证、手机号 等,对应一份"背调报告"

> 背调状态包括:-10:已取消;30:待支付;40:待授权;45:背调中;50:已出报告 > 背调初始状态是[待支付];"订单"被成功支付后背调状态自动流转为[待授权];授权后的背调状态流转为[背调中]并开启"背调调查项"状态流转;所有"背调调查项"完成[状态为处理成功/处理失败],则该背调状态自动更新成[已出报告]

授权方式在创建"订单"的时候选择,包括 短信授权 和 接口文件授权
短信授权意味着候选人的实名手机将收到授权链接短信完成授权行为
接口文件授权意味着需要调用接口传递授权文件来完成授权行为
背调调查项

每个背调调查项关联一个"背调"和一个"调查项"

> 背调调查项状态包括:0:初始化;1:待处理;2:处理成功;9:处理失败 > 背调调查项初始状态是[初始化];"背调"被成功授权后背调调查项状态自动流转为[待处理];处理完则更新成[处理成功/处理失败]

最佳实践

0 . 验证企业配置(可选,验证当前请求使用的配置和方式是否正确) 1 . 创建套餐(可选,通过易背调Saas操作) 2 . [创建订单](https://www.showdoc.cc/ybd?page_id=1876012015654232 "创建订单")("套餐"或"调查项" + 候选人信息组成的"背调") 3 . [支付订单](https://www.showdoc.cc/ybd?page_id=1879706244801399 "支付订单") 4 . 授权背调

 4.1 如果创建"订单"时选择的授权方式是"短信授权",候选人实名手机将收到授权链接短信,签署电子合同来完成授权行为
 4.2 如果创建"订单"时选择的授权方式是"接口文件授权",则需要调用 背调授权(API文件) 接口传递授权文件来完成授权行为

5 . [获取报告](https://www.showdoc.cc/ybd?page_id=1882885347695277 "获取报告")

5.1 "背调"完成前(进行中状态)可以通过[生成临时报告]接口获取临时报告
5.2 "背调"完成后会自动生成最终报告,可以通过[查看背调详情]接口获取

页面列表

ITEM_HTML