Photo ID Verification

this service allows you verify different types of data using submitted images of a photo id as well as a selfie image of a user holding a photo id you can choose to just verify the validity and possesion of the id document, or you can pass additional information such as name, address, and dob and request that that data is verified alongside the id if you have a bluecheck domain token you can try out the api in the swagger utility below just click the "authorize" button and add in you domain token after the entering the "bearer" prefix if you do not have a domain token, you can register for one here field reference you can find descriptions for the fields used in the verification order, verification, data, and config objects used by the api click on the headings to expand the objects verification order the verification order object contains the info used to start the verification process it is where you can set the return url as well as check on the status of the order field / object description status there are three statuses new the verification order has been created, but the images have nit yet been submitted and the order has not been billed processing the images have been submitted and the verification is now under way completed the verification process is finished uuid a unique identifier for the order provided by bluecheck can be used to look up the order using the get method external id an identifier provided by the client used to link the order to client records notification url the url used for webhook notifications return url the url the user returns to after completing verification note this is only if the verification is completed using the public url public url a url where the user can go to upload the documents needed to complete the verification type the type of verification being performed, in this case "photo id" created at the time the verification orders was created updated at the time of the last update to the verification order verification the verification object holds information relating to the verification requested in the initial verification order, such as its status uuid a unique identifier for the verification provided by bluecheck can be used to look up the order using the get method workflow the type of verification to be performed process either automated or manual, depending if human review was used during the verification process status there are three statuses waiting the verification is waiting on additional information and or data from the user pending bluecheck is currently processing the verification approved the verification has been completed and the data was verified failed the verification has been completed but the data could not be verified expired if bluecheck does not receive the data to complete the verification before the verificationc expires, the verification is cancelled and unable to be completed by the end user reason a reason that exmplains why the verification is in the current status invalid seflie the selfie image submitted in the verification attempt was unable to be used invalid id the id image submitted in the verification attempt was unable to be used invalid selfie id both images submitted in the verification attempt were unable to be used edited images the images submitted for verification were edited name mismatch the name submitted with the verification does not match the name on the id document address mismatch the address submitted with the verification does not match the name on the id document dob mismatch the date of birth submitted with the verification does not match the name on the id document other rarely used, the user's verification was rejected for an undefined reason expired the user did not submit all the information required to complete the verification before the verification's expiration time expires at the timestamp when the verification will expire and no longer be able to be completed created at the timestamp when the verification was created updated at the timestamp for the last time the verification was updated data the data object contains the information that will be used to perform the verification email the email of the user being verified this field is always required phone the phone number of the user being verified should be submitted in the +11234567890 format address the address object this object contains all of the fields composing the users full address line 1 the first line of the user's street address ex 123 main street line 2 any additional street address information ex apt #12 city the city of the user postal code the postal code or zip code of the user's address disctrict the state, province, region, etc where the country the name of the user's country/ config the values in the config object are set by the requester and determine the parameters of the verification including which information is verified max attempts the maximum number of attempts the user has to submit data to complete the verification checkups the additional data fields that are to be verified this endpoint supports name, address, and dob document liveness the threshold score required to pass bluecheck's automated document livliness ai the default is 0 8 face detection the number of faces required to be detected by face bluecheck's face detection ai the default is 2 we recommend using 2 or 3 here face comparison the number of matched faces required to pass bluecheck's face comparison ai the default is 2 we recommend using 2 or 3 her try it out