/
Update KYC settings

Update KYC settings

Request

Updates KYC settings.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Settings for KYC analysis.

identityProofobject(KycSettingsIdentity)

Identity proof settings.

addressProofobject(KycSettingsAddress)

Address proof settings.

uiVersionstring or null

Version of the KYC document gatherer UI.

Default:"1"
Enum ValueDescription
1

Classic design.

2

Modern design, optimized for the best user experience on both mobile and desktop devices.

curl -i -X PUT \
  https://www.rebilly.com/_mock/catalog/all/kyc-settings \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "identityProof": {
      "weights": {
        "containsImage": 100,
        "isIdentityDocument": 100,
        "isPublishedOnline": 100,
        "firstName": 100,
        "lastName": 100,
        "expirationDate": 100,
        "dateOfBirth": 100,
        "issueDate": 100,
        "hasMinimalAge": 100,
        "hasMatchingFaceProof": 100,
        "nationality": 100,
        "documentSubtype": 100,
        "isTampered": 100,
        "isPhotocopy": 100,
        "mrzChecksum": 100
      },
      "thresholds": {
        "rejectBelow": 100,
        "acceptAbove": 100
      },
      "minimumAgeSettings": {
        "defaultMinimumAge": 18,
        "locationOverrides": [
          {
            "country": "US",
            "minimumAge": 21
          },
          {
            "country": "US",
            "state": "AL",
            "minimumAge": 19
          }
        ]
      }
    },
    "addressProof": {
      "weights": {
        "firstName": 100,
        "lastName": 100,
        "line1": 100,
        "city": 100,
        "region": 100,
        "postalCode": 100,
        "date": 100,
        "phone": 100,
        "documentSubtype": 100,
        "isTampered": 100
      },
      "thresholds": {
        "rejectBelow": 100,
        "acceptAbove": 100
      }
    },
    "uiVersion": "1"
  }'

Responses

KYC settings updated.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
identityProofobject(KycSettingsIdentity)

Identity proof settings.

addressProofobject(KycSettingsAddress)

Address proof settings.

uiVersionstring or null

Version of the KYC document gatherer UI.

Default:"1"
Enum ValueDescription
1

Classic design.

2

Modern design, optimized for the best user experience on both mobile and desktop devices.

Response
{
  "identityProof": {
    "weights": { … },
    "thresholds": { … },
    "minimumAgeSettings": { … }
  },
  "addressProof": {
    "weights": { … },
    "thresholds": { … }
  },
  "uiVersion": "1"
}