Create Verify Policy

POST {{apiPath}}/environments/{{envID}}/verifyPolicies

Create a new verify policy for the specified environment with the POST {{apiPath}}/environments/{{envID}}/verifyPolicies request.

The first example response returns when .provider.auto is Veriff. The second example response returns when .provider.auto is not provided.

Prerequisites

• See PingOne Verify and Verify Policies for important overview information.

See Verify policy data model for full property descriptions.

governmentId - Government identification document configuration object

facialComparison - Facial comparison configuration object

liveness - Liveness configuration object

email and phone - Email address and phone number configuration object

transaction - Transaction configuration object

The notification.variantName in the email and phone configuration objects can define a variant for the email_phone_verification notification submitted in notification.templateName, if needed. After receipt of a Create Verify Transaction request, the verification service uses an email_phone_verification notification template to send notice of the action taken to the user via email or SMS text.

Note: A policy-specific locale cannot be specified for the email_phone_verification notification. The notification uses the user's preferred language or, if the user has no preferred language, the default language of the environment.

Note: When setting timeouts in the transaction configuration object, dataCollection.timeout.duration must be less than or equal to timeout.duration. Use caution when reducing the timeouts below the defaults to avoid an unfavorable user experience.

Request Body

{"name"=>"Verify everything", "description"=>"All types required", "default"=>false, "governmentId"=>{"verify"=>"REQUIRED", "inspectionType"=>"AUTOMATIC", "failExpiredId"=>"true", "retry"=>{"attempts"=>3}, "provider"=>{"auto"=>"VERIFF", "manual"=>"MITEK"}}, "facialComparison"=>{"verify"=>"REQUIRED", "threshold"=>"HIGH"}, "liveness"=>{"verify"=>"REQUIRED", "threshold"=>"HIGH", "retry"=>{"attempts"=>3}}, "email"=>{"verify"=>"REQUIRED", "createMfaDevice"=>true, "otp"=>{"attempts"=>{"count"=>5}, "lifeTime"=>{"duration"=>10, "timeUnit"=>"MINUTES"}, "deliveries"=>{"count"=>3, "cooldown"=>{"duration"=>30, "timeUnit"=>"SECONDS"}}, "notification"=>{"templateName"=>"email_phone_verification"}}}, "phone"=>{"verify"=>"REQUIRED", "createMfaDevice"=>true, "otp"=>{"attempts"=>{"count"=>5}, "lifeTime"=>{"duration"=>10, "timeUnit"=>"MINUTES"}, "deliveries"=>{"count"=>3, "cooldown"=>{"duration"=>30, "timeUnit"=>"SECONDS"}}, "notification"=>{"templateName"=>"email_phone_verification"}}}, "transaction"=>{"timeout"=>{"duration"=>30, "timeUnit"=>"MINUTES"}, "dataCollection"=>{"timeout"=>{"duration"=>15, "timeUnit"=>"MINUTES"}}, "dataCollectionOnly"=>false}}

RESPONSES

status: Created

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/verifyPolicies/fec27b2c-a1be-4c96-9eed-f0de64ad6408"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"fec27b2c-a1be-4c96-9eed-f0de64ad6408","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Verify everything","description":"All types required","default":false,"governmentId":{"verify":"REQUIRED","inspectionType":"AUTOMATIC","failExpiredId":"true","retry":{"attempts":3},"provider":{"auto":"MITEK","manual":"MITEK"}},"facialComparison":{"verify":"REQUIRED","threshold":"HIGH"},"liveness":{"verify":"REQUIRED","threshold":"HIGH","retry":{"attempts":3}},"email":{"verify":"REQUIRED","createMfaDevice":true,"otp":{"attempts":{"count":5},"lifeTime":{"duration":10,"timeUnit":"MINUTES"},"deliveries":{"count":3,"cooldown":{"duration":30,"timeUnit":"SECONDS"}},"notification":{"templateName":"email_phone_verification"}}},"phone":{"verify":"REQUIRED","createMfaDevice":true,"otp":{"attempts":{"count":5},"lifeTime":{"duration":10,"timeUnit":"MINUTES"},"deliveries":{"count":3,"cooldown":{"duration":30,"timeUnit":"SECONDS"}},"notification":{"templateName":"email_phone_verification"}}},"voice":{"verify":"DISABLED","enrollment":false,"textDependent":{"samples":3,"phrase":{"id":"exceptional_experiences"}},"comparison":{"threshold":"MEDIUM"},"liveness":{"threshold":"MEDIUM"},"referenceData":{"retainOriginalRecordings":false,"updateOnReenrollment":true,"updateOnVerification":true}},"transaction":{"timeout":{"duration":30,"timeUnit":"MINUTES"},"dataCollection":{"timeout":{"duration":15,"timeUnit":"MINUTES"}},"dataCollectionOnly":false},"verifiableCredential":{"verify":"DISABLED","protocol":"NATIVE"},"createdAt":"2024-04-10T20:26:06.326Z","updatedAt":"2024-04-10T20:26:06.330Z"}