Cash-on-delivery risk check
POST
/api/v1/business/website/cod-risk-check/
Check a phone number against the store's COD spam protection before offering cash on delivery. When the number is risky and advance payment is configured, advance_config describes what to collect.
Authorizations
apiKey
Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.
Type
API Key (header: X-Periscale-Key)
Request Body
application/json
JSON "phone": "string"
{
}
Responses
Risk assessment.
application/json
JSON "status": true, "status_code": 0, "message": "string", "data": { "is_risky": true, "advance_required": true, "advance_config": null }
{
}