1.在线签约接口
>d 请正确选择贵司的签约方式,如不知晓具体签约方式,可联系商务支持;
## 时序图
![image.png](https://cos.easydoc.net/74722269/files/kxo3tmey.png)
## 1.提交在线签约信息接口
#### 接口地址:
/open/api/v1/sign/contract
#### 请求方式:POST
>d 根据身份证号累计失败次数,达到5次(包含第5次)
系统拦截提示“你已连续多次认证失败,请2小时后再进行认证。”
1、三要素或者四要素认证不通过,累计一次
2、验证码提交错误,累计一次
#### 请求参数说明:
|参数名称|参数含义|数据类型|是否必填|参数备注|
|-|-|-|-|-|
|realName|真实姓名|String|是||
|idCard|身份证号码|String|是||
|mobile|手机号|String|是||
|cardNo|银行卡号|String|否|银行卡四要素必填|
|signingType|签约类型|Integer|是|请参考下面【签约类型说明】|
>d 备注:银行卡四要素 :姓名,身份证,银行卡,手机号码。运营商三要素 :姓名,身份证,手机号码
#### 签约类型说明:
| signingType |说明|
|-|-|-|
|2|银行卡四要素|
|3|运营商三要素|
#### 响应参数说明:
|参数名称| 参数含义|数据类型| 是否必有| 参数备注|
|-|-|-|-|-|
|personAccountId|签约账户流程ID|String|是|该值用于下个接口签约使用,作为本次发起签署流程的唯一标识|
#### 异常参数说明:
|code| status|解析信息| 解决方案| 备注|
|-|-|-|-|-|
|AUTH_OVER_TIMES|1032|你已连续多次认证失败,请24小时后再进行认证。|||
|DATA_NOT_EXIST|1|XXX参数不存在|||
|KEYS_ERROR|1006|三要素(姓名,身份证,手机号)校验错误|确认上传的姓名、身份证、手机号信息是否正确||
|AUTH_FIAL|1033|三要素(姓名,身份证,手机号)校验错误|||
|REAL_NAME_ERROR|1028|实名认证失败|||
|USER_SIGN|1029|您已经签约过了,请重新登入刷新|||
|SMS_ERROR|1006|验证码错误|||
|RQUEST_FAST|9010|请求频率太快|||
|IS_EMPLOYED_NOT_SIGN|8031|签约失败,已注册过个体工商户!|||
|USER_SIGN_AGE_OUT_LIMIT|1037|系统检测到您的年龄不符合平台规则,暂时无法签约,感谢您的理解|||
|UNABLE_TO_SIGN|10025|暂不能签约,请联系客服|||
|PARAM_ILLEGAL|3|手机号码已经被绑定||
## 2.验证码确认签约接口
#### 接口地址:
/open/api/v1/sign/contract/submit
#### 请求方式:POST
#### 请求参数说明:
|参数名称|参数含义|是否必填|参数备注|
|-|-|-|-|
|code|验证码|是||
|personAccountId|签约账户流程ID|是||
#### 响应参数说明:
|参数名称| 参数含义|数据类型| 是否必有| 参数备注|
|-|-|-|-|-|
|url|签约成功的协议链接|String|是|多个链接用逗号拼接返回|
#### 异常参数说明:
|code| status|解析信息| 解决方案| 备注|
|-|-|-|-|-|
|USER_SIGN|1029|您已经签约过了,请重新登入刷新|||
|RQUEST_FAST|9010|请求频率太快|||
|PARAM_ILLEGAL|9000|参数不合法:XXX|||
## 3.签约结果查询接口
#### 接口地址:
/open/api/v1/sign/result
#### 请求方式:POST
#### 请求参数说明:
|参数名称|参数含义|是否必填|参数备注|
|-|-|-|-|
|无参数名称|需要查询的身份证号码|是|例如:[身份证号1,身份证号2]|
>d 该接口参数无需参数名称只需将身份证号码拼接处json数组即可
示例:String data = [\"idCard1\",\"idCard2\"... ,\"idCard10\"];
一次性最多查询10条记录
#### 接口响应参数data字段解密后的参数说明:
|参数名称| 参数含义|数据类型| 是否必有| 参数备注|
|-|-|-|-|-|
|idCard| 身份证号|String| 是||
|status| 结果状态|int| 是|详情请参考下面【签约状态码说明】|
|url| 签约成功协议地址|String|否| |只是签约成功的状态才会有该值|
>d该结算结果data解密后为List 集合json字符串。
结果示例
[{"idCard":"idCard1","status":xx,"url":"xxxx"},
{"idCard":"idCard2","status":xx,"url":"xxxx"}]
#### 签约状态码说明
|status|说明|
|-|-|-|
|0|用户未签约|
|2|签约成功|
|3|签约待更新|
#### 异常参数说明:
|code| status|解析信息| 解决方案| 备注|
|-|-|-|-|-|
|PARAM_ILLEGAL|9000|参数不合法 不符合json格式传参|||
|PARAM_NOT_EXIST|9001|身份证号码为空|||
|PARAM_ERROR|9006|查询数据不可大于10条|||
|RQUEST_FAST|9010|请求频率太快|||