Resolve document subtype restrictions

Request

Resolves document subtype restrictions for a website. When documents are provided, the response contains restrictions that match the document types, subtypes, and face proof requirements.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired
websiteIdstring, <= 50 characters(WebsiteId)required
Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
documentsArray of objects, <= 20 items(ResolveScopedKycSettingsDocument)
KYC document settings to evaluate for subtype restrictions. If omitted or empty, the response contains only unconditional restrictions for all configured document types.
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/kyc-settings/resolve-scoped-settings \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
    "documents": [
      {
        "type": "identity-proof",
        "subtypes": [
          "passport"
        ],
        "faceProofRequired": false
      }
    ]
  }'

Responses

Scoped KYC settings resolved.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
subtypeRestrictionsobject(KycSubtypeRestrictions)required
Document subtype restrictions that match the request.
Example:
{
  "identityProof": [
    "driver-license",
    "public-health-card"
  ]
}
Response
{
  "subtypeRestrictions": {
    "identityProof": [ … ]
  }
}