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.
scopedKycSettingsScopedKycSettings (object) or null
One of:

Document subtype restrictions for an organization and the websites associated with it. Proof type keys are identityProof, addressProof, fundsProof, and purchaseProof. This object does not include credit-file-proof because it has no subtypes. Restrictions at the organization level apply by default. A website overrides the organization restrictions for a proof type when prohibitedSubtypes is specified.

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": 0,
        "isIdentityDocument": 0,
        "isPublishedOnline": 0,
        "firstName": 0,
        "lastName": 0,
        "expirationDate": 0,
        "dateOfBirth": 0,
        "issueDate": 0,
        "hasMinimalAge": 0,
        "hasMatchingFaceProof": 0,
        "nationality": 0,
        "documentSubtype": 0,
        "isTampered": 0,
        "isPhotocopy": 0,
        "mrzChecksum": 0,
        "documentNumber": 0,
        "issuanceCountry": 0,
        "issuanceRegion": 0
      },
      "thresholds": {
        "rejectBelow": 0,
        "acceptAbove": 0
      },
      "minimumAgeSettings": {
        "defaultMinimumAge": 18,
        "locationOverrides": [
          {
            "country": "US",
            "minimumAge": 21
          },
          {
            "country": "US",
            "state": "AL",
            "minimumAge": 19
          }
        ]
      },
      "faceProofSettings": {
        "minimumBrightness": 40
      }
    },
    "addressProof": {
      "weights": {
        "firstName": 0,
        "lastName": 0,
        "line1": 0,
        "city": 0,
        "region": 0,
        "postalCode": 0,
        "date": 0,
        "phone": 0,
        "documentSubtype": 0,
        "isTampered": 0
      },
      "thresholds": {
        "rejectBelow": 0,
        "acceptAbove": 0
      }
    },
    "scopedKycSettings": {
      "identityProof": {
        "prohibitedSubtypes": {
          "driver-license": {}
        }
      },
      "addressProof": {
        "prohibitedSubtypes": {
          "income-statement": {}
        }
      },
      "websiteOverrides": [
        {
          "websiteIds": [
            "web_abc"
          ],
          "identityProof": {
            "prohibitedSubtypes": {
              "public-health-card": {
                "when": {
                  "faceProofRequired": false
                }
              },
              "birth-certificate": {}
            }
          }
        }
      ]
    },
    "uiVersion": "1"
  }'

Responses

KYC settings updated.
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
identityProofobject(KycSettingsIdentity)
Identity proof settings.
addressProofobject(KycSettingsAddress)
Address proof settings.
scopedKycSettingsScopedKycSettings (object) or null
One of:

Document subtype restrictions for an organization and the websites associated with it. Proof type keys are identityProof, addressProof, fundsProof, and purchaseProof. This object does not include credit-file-proof because it has no subtypes. Restrictions at the organization level apply by default. A website overrides the organization restrictions for a proof type when prohibitedSubtypes is specified.

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": { … },
    "faceProofSettings": { … }
  },
  "addressProof": {
    "weights": { … },
    "thresholds": { … }
  },
  "scopedKycSettings": {
    "identityProof": { … },
    "addressProof": { … },
    "websiteOverrides": [ … ]
  },
  "uiVersion": "1"
}