{"info":{"_postman_id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","name":"Crypton Mobile CryptoVerifi API","description":"

Crypton Mobile CryptoVerifi API is a secure and easy way to verify identity of your customers. CryptoVerifi evaulates the authenticity of your customers with their passport, driver's license, and self photo. This documentation will help you get started with using CryptoVerifi API's endpoints.

\n

Overview

\n
    \n
  1. You will need an API Key and Secret code to use any endpoints. Authorization is basic auth over HTTPS/TLS. You just need to include in every request your authorization header key and value. Your API key would be your basic auth username and API secret as the password.
    2. \n
  2. All requests should be done over HTTPS
    3. \n
  3. Request body and response to every request is in JSON format. Make sure to set Content-Type: application/json in the headers of every request.
    4. \n
  4. HTTP status codes will be sent to every response to any API call. 200 OK response means the call was successful. 4XX or 5XX response means there was an error on the API call.
    5. \n
  5. All errors are represented by a JSON response of \"error\": {} key indicating the name of the error and a description.
    6. \n
  6. If you need help on using CryptonMobile CryptoVerifi API, you may send an email to support@cryptonmobile.com
    7. \n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15179653","collectionId":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","publishedId":"Uz5KmaKy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-11-23T10:28:57.000Z"},"item":[{"name":"Get VerifiLink","id":"e7fd517a-d2bb-4ef1-8a63-99f883503590","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"RedirectUrl\": \"https://yoururl.com/redirect-here\",\r\n \"StatusCallbackUrl\":\"https://yourdomain.com/callbackreceiver.php\",\r\n \"CustomFields\":[\r\n {\r\n \"name\": \"CustomerName\",\r\n \"value\": \"John Smith\"\r\n },\r\n {\r\n \"name\": \"Address\",\r\n \"value\": \"123 Gregory Ave. Tulare, CA 93274\"\r\n }\r\n ]\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptoverifiapi.edocs.co/v1/verifilink","description":"

This endpoint allows you to get a Verifi Link that you can use to integrate or embed our identity verification solution into your own application.

\n

The user will be the one to upload his/her own ID photo and perform liveness detection. CryptoVerifi API will securely capture the data, process the verification, and return a response whether the user has passed authenticity or not.

\n

Request Notes

\n
    \n

  1. RedirectUrl (string, optional) - This is the URL that you can use to redirect back to your application after the identity verification process. This is where you would like the user to continue after a successful verification.

    \n
    2. \n

  2. StatusCallbackUrl (string, optional) - If you want to receive real-time status updates of your request, place your Callback URL here. Our API will do an HTTP POST to your Callback URL as soon as there's a change in the status of the session.

    \n
    3. \n

  3. CustomFields (string, optional) - A CustomField is a Name and Value pair that lets you include additional information to the session. Here is a sample snippet of how the CustomFields element looks like:

    \n
    4. \n
\n
 ...\n \"CustomFields\": [\n {\n \"Name\": \"CustomerName\",\n \"Value\": \"John Smith\"\n }\n ]\n ...\n\n
\n

Response Notes

\n

A successful response will contain the following elements:

\n
    \n

  1. SessionId - This is a unique identifier that you can use to query a verification result via the Get Verification Result endpoint.

    \n
    2. \n

  2. Link - This is the auto-generated Verifi Link that your application should use to start the identify verification process. This link is only valid for 60 seconds. When this link is accessed, this is where the CryptoVerifi authentication process will be performed.

    \n
    3. \n

  3. ValidUntil - The Verifi Link is valid only until this datetime. Values here are in UTC.

    \n
    4. \n

  4. RedirectUrl - This is a reference to the same RedirectUrl you passed during the API request.

    \n
    5. \n
\n

Here is how CryptoVerifi verification page will look like when it is embedded in your application:

\n\n\n

*The Company Logo as seen above may be customized with your own logo upon request.

\n

The user will be asked to upload a photo of his/her valid Identification Card followed by liveness detection that will require capturing of user's live movements. Sets of illustrated instructions will help the user upload a clear photo for better processing:

\n\n\n

Liveness Detection

\n

This is a secure authentication process where the system will determine the live presence of a user as opposed to a static picture such as photos. The user will be shown a series of illustrated instructions which will take less than 10 seconds to finish. This is the last step for verification.

\n\n\n

CryptoVerifi API will securely capture the submitted ID, process the captured liveness detection, start authenticity processing which will take several seconds then assess if the user is successfully verified or not.

\n\n\n

After a successful verification, clicking on the Continue button will redirect the user to a redirectURL parameter appended with an action tag indicating that the authenticated user agreed to continue with your transaction.

\n

Verification for Manual Review

\n

After two failed customer verification attempts, submitted verification IDs and selfies will be subjected to manual review. The administrator may either approve or deny the verification based on the uploaded images from the customer. See Get Manual Review Link for more information on this endpoint.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","name":"Crypton Mobile CryptoVerifi API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","verifilink"],"host":["cryptoverifiapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"3747b2d3-bb40-4d3e-b567-7e4650e5fe59","name":"Get VerifiLink","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"RedirectUrl\": \"https://yoururl.com/redirect-here\",\r\n \"StatusCallbackUrl\":\"https://yourdomain.com/callbackreceiver.php\",\r\n \"CustomFields\":[\r\n {\r\n \"name\": \"CustomerName\",\r\n \"value\": \"John Smith\"\r\n },\r\n {\r\n \"name\": \"Address\",\r\n \"value\": \"123 Gregory Ave. Tulare, CA 93274\"\r\n }\r\n ]\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptoverifiapi.edocs.co/v1/verifilink"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 07 Jun 2022 07:45:59 GMT"},{"key":"Content-Length","value":"356"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionId\": \"{sessionId}\",\n \"link\": \"https://cryptoverifi.edocs.co/identityverification?t=OL7AXrmdnqfrqRo3J8nWHwoAAKwO8pc0MpqyWM4R...\",\n \"validUntil\": \"2022-06-07T07:46:59.5288572Z\",\n \"redirectUrl\": \"https://yoururl.com/redirect-here\"\n}"}],"_postman_id":"e7fd517a-d2bb-4ef1-8a63-99f883503590"},{"name":"Get Verification Result","id":"040fd112-32af-47df-a440-e561840e0e0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cryptoverifiapi.edocs.co/v1/identityverification/{SessionId}","description":"

This endpoint allows you to get the result of an identity verification session. You will need to place the SessionId at the end of the endpoint URL.

\n

Response Notes

\n

A successful request will be have a HTTP 200 OK response with a body containing the following elements:

\n
    \n
  1. SessionId - This is a reference of the same Session Id that was entered on your API request.
    2. \n
  2. IdType - This is the type of ID used in the verification process. Valid values are: Passport, DriversLicense, OtherId
    3. \n
  3. IdentityVerified - Boolean value. Returns true if the customer's identity is successfully verified; false, otherwise.
    4. \n
  4. Similarity - This is the facial match similarity value. A higher value (nearest to 100.00) means that the facial similarity is accurate. This will determine the authenticity of the uploaded Identification Card when compared to the Self photo.
    5. \n
  5. Decision - This contains the identity verification result description.
    6. \n
\n

If the request is unsuccessful, the response will have a HTTP 400 Bad Request status along with a body containing the description of the error in JSON format.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","name":"Crypton Mobile CryptoVerifi API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","identityverification","{SessionId}"],"host":["cryptoverifiapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"89a548db-04da-4fff-8911-05ad6c84ff6e","name":"Get Verification Result","originalRequest":{"method":"GET","header":[],"url":"https://cryptoverifiapi.edocs.co/v1/identityverification/{SessionId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 07 Jun 2022 07:47:44 GMT"},{"key":"Content-Length","value":"164"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionId\": \"{sessionId}\",\n \"idType\": \"DriversLicense\",\n \"identityVerified\": true,\n \"similarity\": 99.98458862304688,\n \"decision\": \"Identity Verified\"\n}"}],"_postman_id":"040fd112-32af-47df-a440-e561840e0e0a"},{"name":"Verify Identity","id":"feeaa85d-5339-497d-a45f-0a71a6214f30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"IdType\": \"DriversLicense\",\r\n \"IdFrontImage\": \"[image file's byte array encoded in Base64]\",\r\n \"IdBackImage\": \"[image file's byte array encoded in Base64]\",\r\n \"SelfieImage\": \"[image file's byte array encoded in Base64]\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptoverifiapi.edocs.co/v1/identityverification","description":"

If you have all the requirements needed and wants to run it against our identity verification process directly, this is the endpoint to use.

\n

Request Notes

\n
    \n
  1. IdType (string, required) - This is the type of ID used in the verification process. Valid values are: Passport, DriversLicense
    2. \n
  2. IdFrontImage (string, required) - This is the front of the ID image. Format should be the image file's byte array encoded in Base64.
    3. \n
  3. IdBackImage (string, optional) - This is the back of the ID image. Format should be the image file's byte array encoded in Base64. This is required if the IdType is DriversLicense and not needed if the IdType is Passport.
    4. \n
  4. SelfieImage (string, required) - This is the customer's selfie image. Format should be the image file's byte array encoded in Base64.
    5. \n
\n

Response Notes

\n

A successful request will be have a HTTP 200 OK response with a body containing the following elements:

\n
    \n
  1. SessionId - This is a unique identifier that you can use to query a verification result via the Get Verificaiton Result endpoint.
    2. \n
  2. IdType - This is the type of ID used in the verification process. Valid values are: Passport, DriversLicense
    3. \n
  3. IdentityVerified - Boolean value. Returns true if the customer's identity is successfully verified; false, otherwise.
    4. \n
  4. Similarity - This is the facial match similarity value. A higher value (nearest to 100.00) means that the facial similarity is accurate. This will determine the authenticity of the uploaded Identification Card when compared to the Self photo.
    5. \n
  5. Decision - This contains the identity verification result description.
    6. \n
\n

If the request is unsuccessful, the response will have a HTTP 400 Bad Request status along with a body containing the description of the error in JSON format.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","name":"Crypton Mobile CryptoVerifi API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","identityverification"],"host":["cryptoverifiapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"d213984e-b449-4a7f-beba-52fb79950aef","name":"Verify Identity","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"IdType\": \"DriversLicense\",\r\n \"IdFrontImage\": \"[image file's byte array encoded in Base64]\",\r\n \"IdBackImage\": \"[image file's byte array encoded in Base64]\",\r\n \"SelfieImage\": \"[image file's byte array encoded in Base64]\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptoverifiapi.edocs.co/v1/identityverification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 07 Jun 2022 07:48:53 GMT"},{"key":"Content-Length","value":"164"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionId\": \"{sessionId}\",\n \"idType\": \"DriversLicense\",\n \"identityVerified\": true,\n \"similarity\": 99.98458862304688,\n \"decision\": \"Identity Verified\"\n}"}],"_postman_id":"feeaa85d-5339-497d-a45f-0a71a6214f30"},{"name":"Get Verification Files","id":"b40a0a20-ca69-416e-b3ab-6ee5c2c27b33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cryptoverifiapi.edocs.co/v1/identityverification/{SessionId}/files","description":"

This endpoint allows you to get the list of files submitted for an identity verification session. You will need the SessionId in the endpoint URL.

\n

Response Notes

\n

A successful request will be have a HTTP 200 OK response with a body containing the following elements:

\n
    \n
  1. IdType - This is the type of ID used in the verification process. Valid values are: Passport, DriversLicense
    2. \n
  2. DateCreated - Returns the datetime in UTC the identity verification were recorded.
    3. \n
  3. SessionFiles - This is a list of files used in the identity verification session. Each item in the list includes the following elements:
    4. \n
\n
    \n
  • ImageType - Identifies the type of image for this file. Valid values are: Front, Back, Selfie
    • \n
  • FileId - This is the file identifier that can be used to download a specific session file via the Download a Verificaiton File endpoint.
    • \n
  • FileUri - This is the API URI for downloading this session file.
    • \n
\n

If the request is unsuccessful, the response will have a HTTP 400 Bad Request status along with a body containing the description of the error in JSON format.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","name":"Crypton Mobile CryptoVerifi API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","identityverification","{SessionId}","files"],"host":["cryptoverifiapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"3314ef00-f015-4890-80c4-f18e25eae10f","name":"Get Verification Files","originalRequest":{"method":"GET","header":[],"url":"https://cryptoverifiapi.edocs.co/v1/identityverification/{SessionId}/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 03 Aug 2022 12:44:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"idType\": \"DriversLicense\",\n \"dateCreated\": \"2022-08-03T12:19:13.157\",\n \"sessionFiles\": [\n {\n \"imageType\": \"Front\",\n \"fileId\": \"{fileId}\",\n \"fileUri\": \"https://cryptoverifiapi.edocs.co/v1/identityverification/{SessionId}/file/{fileId}\"\n },\n {\n \"imageType\": \"Back\",\n \"fileId\": \"{fileId}\",\n \"fileUri\": \"https://cryptoverifiapi.edocs.co/v1/identityverification/{SessionId}/file/{fileId}\"\n },\n {\n \"imageType\": \"Selfie\",\n \"fileId\": \"{fileId}\",\n \"fileUri\": \"https://cryptoverifiapi.edocs.co/v1/identityverification/{SessionId}/file/{fileId}\"\n }\n ]\n}"}],"_postman_id":"b40a0a20-ca69-416e-b3ab-6ee5c2c27b33"},{"name":"Download a Verification File","id":"c499c370-febf-4fe5-b53b-f3bed0c46c86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cryptoverifiapi.edocs.co/v1/identityverification/{SessionId}/file/{FileId}","description":"

This endpoint allows you to download a specific verification file. You will need the SessionId and FileId that you get from the Get Verification Files endpoint response.

\n

The response for this endpoint is the actual image file.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","name":"Crypton Mobile CryptoVerifi API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","identityverification","{SessionId}","file","{FileId}"],"host":["cryptoverifiapi","edocs","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"c499c370-febf-4fe5-b53b-f3bed0c46c86"},{"name":"Get Manual Review Link","id":"482b1c4b-83fd-47c9-a665-0998823c61e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cryptoverifiapi.edocs.co/v1/manualreviewlink/{sessionId}","description":"

This endpoint allows you to retrieve a Manual Review Link for a specific session ID. You can use this link to approve or deny the verification manually. This feature supports additional verification for certain cases where automated verification might not be sufficient or in situations requiring manual checking.

\n\n\n

The generated link will direct you to a page displaying the uploaded ID (Driver's License or Passport) and selfie of the customer for manual review:

\n\n\n

Response Notes

\n

A successful request will have an HTTP 200 OK response with a body containing the following elements:

\n
    \n
  • sessionId: The unique identifier (ID) associated with the CryptoVerifi session.
    • \n
  • link: The URL link that grants access to the Manual Review page for the specified session.
    • \n
  • validUntil: The expiration timestamp (UTC) indicating until when the Manual Review Link remains valid.
    • \n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","name":"Crypton Mobile CryptoVerifi API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","manualreviewlink","{sessionId}"],"host":["cryptoverifiapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"a6eb2eaa-c203-4a8f-858b-41c3e036885a","name":"Get Manual Review Link","originalRequest":{"method":"GET","header":[],"url":"https://cryptoverifiapi.edocs.co/v1/manualreviewlink/{sessionId} "},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"sessionId\": \"{sessionId}\",\n \"link\": \"https://cryptoverifi.edocs.co/IdentityVerificationManualReview?t=Y50Z...\",\n \"validUntil\": \"2023-07-17T09:28:41.2510659Z\"\n}"}],"_postman_id":"482b1c4b-83fd-47c9-a665-0998823c61e3"},{"name":"Get View Link","id":"92f4b398-9d05-4642-9a92-3c9827c7a103","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cryptoverifiapi.edocs.co/v1/viewlink/{sessionId}","description":"

This endpoint allows you to view and download successfully verified IDs and selfies of a single session. Users can access this link using a web browser to retrieve successfully verified documents.

\n\n\n

Response Notes

\n

A successful request will have an HTTP 200 OK response with a body containing the following elements:

\n
    \n
  • sessionId: The unique identifier (ID) associated with the CryptoVerifi session.
    • \n
  • link: The URL that grants access to view and download verified identification documents and selfies for the specified session.
    • \n
  • validUntil: The expiration timestamp (UTC) indicating until when the View Link remains valid.
    • \n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","id":"61f6b2a0-ec1d-44a5-bf88-b5321701cff1","name":"Crypton Mobile CryptoVerifi API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","viewlink","{sessionId}"],"host":["cryptoverifiapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"ec6d8fe4-e76e-43aa-9d23-e6b1eb34ceac","name":"Get View Link","originalRequest":{"method":"GET","header":[],"url":"https://cryptoverifiapi.edocs.co/v1/viewlink/{sessionId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionId\": \"{sessionId}\",\n \"link\": \"https://cryptoverifi.edocs.co/IdentityVerificationViewFile?t=4NzLl36O8E...\",\n \"validUntil\": \"2023-07-17T09:33:59.3263767Z\"\n}"}],"_postman_id":"92f4b398-9d05-4642-9a92-3c9827c7a103"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"409eaac5-df11-4ba8-b21e-87336db40d02","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1a403dc5-257a-480e-9821-477b7c0eee63","type":"text/javascript","exec":[""]}}]}