PUT /kyc-settings
Updates KYC settings.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
uiVersion |
String | No |
Version of the KYC document gatherer UI. Valid values:
Default value: "1" |
identityProof |
Object | No |
Identity proof settings. |
identityProof.weights |
Object | No |
Property weights that are used for the KYC document verification process. All KYC documents start the verification process with a score of 100.
If a check fails, the score is reduced by the corresponding weight.
For example, if the |
identityProof.weights.isPublishedOnline |
Integer | No |
Weight added if an exact match of the document is not found online. |
identityProof.weights.issueDate |
Integer | No |
Weight added if an issue date is not detected on the document. |
identityProof.weights.hasMinimalAge |
Integer | No |
Weight added if the document does not verify the minimal age limit. Minimal age is 21+ the for USA and 18+ for all other countries. |
identityProof.weights.isPhotocopy |
Integer | No |
Weight added if the document is detected as a photocopy. |
identityProof.weights.isTampered |
Integer | No |
Weight added if the document has been tampered with. |
identityProof.weights.expirationDate |
Integer | No |
Weight added if an expiration date is not detected on the document. |
identityProof.weights.hasMatchingFaceProof |
Integer | No |
Weight added if an identity document does not have matching face proof. |
identityProof.weights.lastName |
Integer | No |
Weight added if the customer's last name is not matched. |
identityProof.weights.nationality |
Integer | No |
Weight added if a nationality is not detected on the document. |
identityProof.weights.documentSubtype |
Integer | No |
Weight added if the document is not one of the recognized document subtypes. |
identityProof.weights.isIdentityDocument |
Integer | No |
Weight added if the document does not resemble an ID. |
identityProof.weights.firstName |
Integer | No |
Weight added if the customer's first name is not matched. |
identityProof.weights.containsImage |
Integer | No |
Weight added if the document does not include an image that contains a face. |
identityProof.weights.matchesDateOfBirth |
Integer | No |
Weight added if an identity document does not have a matching date of birth. |
identityProof.weights.dateOfBirth |
Integer | No |
Weight added if a date of birth is not detected on the document. |
identityProof.thresholds |
Object | No |
Pass and fail threshold definition for the document verification process. |
identityProof.thresholds.acceptAbove |
Integer | No |
Overall score by which an identity proof document passes the verification process. |
identityProof.thresholds.rejectBelow |
Integer | No |
Overall score by which an identity proof document fails the verification process. |
identityProof.minimumAgeSettings |
Object | No |
Minimum age settings for identity proof documents. |
identityProof.minimumAgeSettings.locationOverrides[] |
Array | No |
Location-specific minimum age. Each item specifies a minimum age for a specific location. For country-wide rules, omit the state field. For state-specific rules, include the state field. |
identityProof.minimumAgeSettings.locationOverrides[].country |
String | Yes |
Country code in ISO 3166 alpha-2 format. |
identityProof.minimumAgeSettings.locationOverrides[].state |
String | No |
Name or code of the state or region. |
identityProof.minimumAgeSettings.locationOverrides[].minimumAge |
Integer | Yes |
Minimum age requirement for this location. |
identityProof.minimumAgeSettings.defaultMinimumAge |
Integer | No |
Default minimum age requirement for identity proof documents. This is used when no location-specific override is configured. Default value: 18 |
addressProof |
Object | No |
Address proof settings. |
addressProof.weights |
Object | No |
Property weights that are used for the KYC document verification process. All KYC documents start the verification process with a score of 100.
If a check fails, the score is reduced by the corresponding weight.
For example, if the |
addressProof.weights.line1 |
Integer | No |
Weight added if the customer's address is not matched. |
addressProof.weights.region |
Integer | No |
Weight added if the customer's region is not matched. |
addressProof.weights.postalCode |
Integer | No |
Weight added if the customer's postal code is not matched. |
addressProof.weights.lastName |
Integer | No |
Weight added if the customer's last name is not matched. |
addressProof.weights.phone |
Integer | No |
Weight added if a phone number is not detected on the document. |
addressProof.weights.documentSubtype |
Integer | No |
Weight added if the document is not one of the recognized document subtypes. |
addressProof.weights.firstName |
Integer | No |
Weight added if the customer's first name is not matched. |
addressProof.weights.date |
Integer | No |
Weight added if a date is not detected on the document. |
addressProof.weights.isTampered |
Integer | No |
Weight added if the document has been tampered with. |
addressProof.weights.city |
Integer | No |
Weight added if the customer's city is not matched. |
addressProof.thresholds |
Object | No |
Pass and fail threshold definition for the document verification process. |
addressProof.thresholds.acceptAbove |
Integer | No |
Overall score by which an identity proof document passes the verification process. |
addressProof.thresholds.rejectBelow |
Integer | No |
Overall score by which an identity proof document fails the verification process. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.