Update KYC settings

Updates KYC settings.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Settings for KYC analysis.

object (KycSettingsIdentity)

Identity proof settings.

object

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 firstName check weight is set to 5, and the check fails, the KYC document score becomes 95.

containsImage
integer [ 0 .. 100 ]

Weight added if the document does not include an image that contains a face.

isIdentityDocument
integer [ 0 .. 100 ]

Weight added if the document does not resemble an ID.

isPublishedOnline
integer [ 0 .. 100 ]

Weight added if an exact match of the document is not found online.

firstName
integer [ 0 .. 100 ]

Weight added if the customer's first name is not matched.

lastName
integer [ 0 .. 100 ]

Weight added if the customer's last name is not matched.

expirationDate
integer [ 0 .. 100 ]

Weight added if an expiration date is not detected on the document.

dateOfBirth
integer [ 0 .. 100 ]

Weight added if a date of birth is not detected on the document.

matchesDateOfBirth
integer [ 0 .. 100 ]

Weight added if an identity document does not have a matching date of birth.

issueDate
integer [ 0 .. 100 ]

Weight added if an issue date is not detected on the document.

hasMinimalAge
integer [ 0 .. 100 ]

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.

hasMatchingFaceProof
integer [ 0 .. 100 ]

Weight added if an identity document does not have matching face proof.

nationality
integer [ 0 .. 100 ]

Weight added if a nationality is not detected on the document.

documentSubtype
integer [ 0 .. 100 ]

Weight added if the document is not one of the recognized document subtypes.

object

Pass and fail threshold definition for the document verification process.

rejectBelow
integer [ 0 .. 100 ]

Overall score by which an identity proof document fails the verification process.

acceptAbove
integer [ 0 .. 100 ]

Overall score by which an identity proof document passes the verification process.

object (KycSettingsAddress)

Address proof settings.

object

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 firstName check weight is set to 5, and the check fails, the KYC document score becomes 95.

firstName
integer [ 0 .. 100 ]

Weight added if the customer's first name is not matched.

lastName
integer [ 0 .. 100 ]

Weight added if the customer's last name is not matched.

line1
integer [ 0 .. 100 ]

Weight added if the customer's address is not matched.

city
integer [ 0 .. 100 ]

Weight added if the customer's city is not matched.

region
integer [ 0 .. 100 ]

Weight added if the customer's region is not matched.

postalCode
integer [ 0 .. 100 ]

Weight added if the customer's postal code is not matched.

date
integer [ 0 .. 100 ]

Weight added if a date is not detected on the document.

phone
integer [ 0 .. 100 ]

Weight added if a phone number is not detected on the document.

documentSubtype
integer [ 0 .. 100 ]

Weight added if the document is not one of the recognized document subtypes.

object

Pass and fail threshold definition for the document verification process.

rejectBelow
integer [ 0 .. 100 ]

Overall score by which an identity proof document fails the verification process.

acceptAbove
integer [ 0 .. 100 ]

Overall score by which an identity proof document passes the verification process.

Responses
200

KYC settings updated.

Response Schema: application/json
object (KycSettingsIdentity)

Identity proof settings.

object

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 firstName check weight is set to 5, and the check fails, the KYC document score becomes 95.

containsImage
integer [ 0 .. 100 ]

Weight added if the document does not include an image that contains a face.

isIdentityDocument
integer [ 0 .. 100 ]

Weight added if the document does not resemble an ID.

isPublishedOnline
integer [ 0 .. 100 ]

Weight added if an exact match of the document is not found online.

firstName
integer [ 0 .. 100 ]

Weight added if the customer's first name is not matched.

lastName
integer [ 0 .. 100 ]

Weight added if the customer's last name is not matched.

expirationDate
integer [ 0 .. 100 ]

Weight added if an expiration date is not detected on the document.

dateOfBirth
integer [ 0 .. 100 ]

Weight added if a date of birth is not detected on the document.

matchesDateOfBirth
integer [ 0 .. 100 ]

Weight added if an identity document does not have a matching date of birth.

issueDate
integer [ 0 .. 100 ]

Weight added if an issue date is not detected on the document.

hasMinimalAge
integer [ 0 .. 100 ]

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.

hasMatchingFaceProof
integer [ 0 .. 100 ]

Weight added if an identity document does not have matching face proof.

nationality
integer [ 0 .. 100 ]

Weight added if a nationality is not detected on the document.

documentSubtype
integer [ 0 .. 100 ]

Weight added if the document is not one of the recognized document subtypes.

object

Pass and fail threshold definition for the document verification process.

rejectBelow
integer [ 0 .. 100 ]

Overall score by which an identity proof document fails the verification process.

acceptAbove
integer [ 0 .. 100 ]

Overall score by which an identity proof document passes the verification process.

object (KycSettingsAddress)

Address proof settings.

object

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 firstName check weight is set to 5, and the check fails, the KYC document score becomes 95.

firstName
integer [ 0 .. 100 ]

Weight added if the customer's first name is not matched.

lastName
integer [ 0 .. 100 ]

Weight added if the customer's last name is not matched.

line1
integer [ 0 .. 100 ]

Weight added if the customer's address is not matched.

city
integer [ 0 .. 100 ]

Weight added if the customer's city is not matched.

region
integer [ 0 .. 100 ]

Weight added if the customer's region is not matched.

postalCode
integer [ 0 .. 100 ]

Weight added if the customer's postal code is not matched.

date
integer [ 0 .. 100 ]

Weight added if a date is not detected on the document.

phone
integer [ 0 .. 100 ]

Weight added if a phone number is not detected on the document.

documentSubtype
integer [ 0 .. 100 ]

Weight added if the document is not one of the recognized document subtypes.

object

Pass and fail threshold definition for the document verification process.

rejectBelow
integer [ 0 .. 100 ]

Overall score by which an identity proof document fails the verification process.

acceptAbove
integer [ 0 .. 100 ]

Overall score by which an identity proof document passes the verification process.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

put/kyc-settings
Request samples
application/json
{
  • "identityProof": {
    },
  • "addressProof": {
    }
}
Response samples
application/json
{
  • "identityProof": {
    },
  • "addressProof": {
    }
}