{"info":{"_postman_id":"bde15a38-e06f-46a8-82f2-ccdcffd42381","name":"Crypton Mobile CryptoStips API","description":"

CryptoStips is a simple and secure way of uploading stipulations such as customer photo requirements like Pay stubs, including but not limited to Proof of identification, income, address, and billing from your local device or mobile phone as part of your business transaction. You will be able to send, download, and get the status of every stips request.

\n

This documentation will help you get started with using CryptoStips API endpoints.

\n

Overview

\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. All requests should be done over HTTPS

  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. 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. All errors are represented by a JSON response of \"error\": {} key indicating the name of the error and a description.

  6. If you need help on using CryptonMobile CryptoStips API, you may send an email tosupport@cryptonmobile.com

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13429452","collectionId":"bde15a38-e06f-46a8-82f2-ccdcffd42381","publishedId":"2s935rLP5r","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-02-09T09:43:58.000Z"},"item":[{"name":"Create Image Request","id":"b90f0a57-8255-40d0-a23e-2aa886912a83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"title\": \"Loan Application for John Wick - Loan # 12345690\",\r\n \"message\": \"Hi John! To continue with your application, please submit your requirements in this link #URL# Reply STOP to stop. \",\r\n \"isSendSMS\": true,\r\n \"isSendEmail\": true,\r\n\t\"statusCallbackUrl\": \"https://your-webhook-url.com\",\r\n \"customer\":{\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Wick\",\r\n \"PhoneNumber\": \"+11234567890\",\r\n \"Email\": \"customer@email.com\"\r\n },\r\n\t\"documents\":[\r\n\t\t{\r\n\t\t\t\"name\": \"Driver's License\",\r\n\t\t\t\"instructions\": \"Please upload a clear copy of your Driver's License\",\r\n\t\t\t\"isRequired\": true\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Passport\",\r\n \"instructions\":\"Please upload a clear copy of your Passport\",\r\n\t\t\t\"isRequired\": true\r\n\t\t},\r\n {\r\n\t\t\t\"name\": \"Payslip\",\r\n\t\t\t\"isRequired\": false\r\n\t\t}\r\n\t],\r\n \"customFields\":[\r\n {\r\n \"name\": \"CustomerName\",\r\n \"value\": \"John Wick\"\r\n },\r\n {\r\n \"name\": \"EmpId\",\r\n \"value\": \"1234\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptostipsapi.edocs.co/v1/imagerequest","description":"

This endpoint allows you to get an Image Request Link that you can use to send to your customers or integrate into your own application. The generated Image Request Link may be sent to a customer via your own application or any messaging application such as SMS/ email/ online messaging.

\n\n\n

The sender can assign any required document, set a custom instruction for each requirement, and set whether the requirement is optional or not. The customer will be the one to upload the stipulation documents such as income documents, proof of residence, pay stubs, bank statements, and identification cards.

\n

Here is how CryptoStips page will look when the upload URL is visited:

\n\n\n

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

\n

The customer will be asked to upload a photo of any required document to an image (jpeg or png) or pdf format. CryptoStips will securely store and host the uploaded file to be retrieved/downloaded by the Sender at any time.

\n\n\n

Request Notes

\n
    \n

  1. Title (string, required) : This will serve as the heading of the Image Request upload page.

    \n
    2. \n

  2. Message (string, required): This is the custom text message the user will receive along with the link. You can set the description, branch codes, customer names, or any custom message that will best describe the upload page. Here is where you include #URL# in the message, which will be replaced by the generated upload link. For email notifications, messages are already set by default.

    \n
    3. \n

  3. IsSendSMS (boolean, required): Setting this to true will enable the API to send an SMS notification to the recipient.

    \n
    4. \n

  4. IsSendEmail (boolean, required): Setting this to true will enable the API to send an email notification to the recipient.

    \n
    5. \n

  5. StatusCallbackUrl (string, optional): This is the webhook URL that you can use to get real-time status on every activity in an API request.

    \n
    6. \n

  6. Customer : A customer is the recipient of the Image Request. The customer section contains the following elements:

    \n
      \n
    • FirstName (string, required): First name of the customer.
      • \n
    • LastName (string, required): Last name of the customer.
      • \n
    • PhoneNumber (string, required): Phone number of the customer.
      • \n
    • Email (string, optional): Email address of the customer.
      • \n
    \n
    7. \n

  7. Documents : This is the list of documents you want to require on your Image Request upload page. You can send single or multiple documents, add instructions, and set the document if required or optional. The Documents section contains the following elements:

    \n
      \n

    • Name (string, required): This refers to the type of document required. Common examples are Driver's Licenses, Passports, Pay Stubs, Proof of Billing, Proof of Income, Utility Bills, and the like.

      \n
      • \n

    • Instructions (string, optional): This is where you can set a specific description or instruction with the document.

      \n
      • \n

    • IsRequired (boolean, required): Boolean indicating whether the document is required. Setting the IsRequired option to true will make the document required, and when false, optional.

      \n
      • \n
    \n
    8. \n

  8. CustomFields : This is a list of name and value pairs that you want to associate with the specific request. If you have additional remarks that were not provided in the previous sections, they can be set in this element. The CustomFields section contains the following elements:

    \n
      \n

    • Name (string, required): This is the name of the variable that you will set.

      \n
      • \n

    • Value (string, required): This contains the value of the variable you set from the Name section. Common Value pairs are remarks, notes, branch codes, and many more.

      \n
      • \n
    \n
    9. \n
\n

Response Notes

\n

A successful request will have an HTTP 200 OK response with a body containing the generated image request link and necessary details including the unique identifier, validity period, and creation timestamp of the image request.

\n","urlObject":{"protocol":"https","path":["v1","imagerequest"],"host":["cryptostipsapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"41476900-a75a-4b48-b3b7-e3ee2c0bf81f","name":"Create Image Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"title\": \"Loan Application for John Wick - Loan # 12345690\",\r\n \"message\": \"Hi John! To continue with your application, please submit your requirements in this link #URL# Reply STOP to stop. \",\r\n \"isSendSMS\": true,\r\n \"isSendEmail\": true,\r\n\t\"statusCallbackUrl\": \"https://your-webhook-url.com\",\r\n \"customer\":{\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Wick\",\r\n \"PhoneNumber\": \"+11234567890\",\r\n \"Email\": \"customer@email.com\"\r\n },\r\n\t\"documents\":[\r\n\t\t{\r\n\t\t\t\"name\": \"Driver's License\",\r\n\t\t\t\"instructions\": \"Please upload a clear copy of your Driver's License\",\r\n\t\t\t\"isRequired\": true\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Passport\",\r\n \"instructions\":\"Please upload a clear copy of your Passport\",\r\n\t\t\t\"isRequired\": true\r\n\t\t},\r\n {\r\n\t\t\t\"name\": \"Payslip\",\r\n\t\t\t\"isRequired\": false\r\n\t\t}\r\n\t],\r\n \"customFields\":[\r\n {\r\n \"name\": \"CustomerName\",\r\n \"value\": \"John Wick\"\r\n },\r\n {\r\n \"name\": \"EmpId\",\r\n \"value\": \"1234\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptostipsapi.edocs.co/v1/imagerequest"},"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":"Strict-Transport-Security","value":"max-age=2592000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 03 Apr 2024 09:40:19 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"imageRequestId\": \"{imageRequestId}\",\n \"imageRequestLink\": \"https://cryptostips.edocs.co/uploadstips?t=abc123xyz\",\n \"linkValidity\": \"2024-04-06T09:40:20.5246675Z\",\n \"dateCreated\": \"2024-04-03T09:40:20.5824669Z\"\n}"}],"_postman_id":"b90f0a57-8255-40d0-a23e-2aa886912a83"},{"name":"Resend Image Request","id":"c05e72ba-3e20-4b22-b712-85960238006c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"isSendSMS\": false,\r\n \"isSendEmail\": true,\r\n \"PhoneNumber\": \"+11234567890\",\r\n \"Email\": \"customer+updated@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptostipsapi.edocs.co/v1/imagerequest/{{imageRequestId}}/resend","description":"

This endpoint allows resending the image request with updated notification preferences.

\n

Request Notes

\n
    \n

  1. IsSendSMS (boolean, optional): Flag indicating whether to send an SMS notification to the user.

    \n
    2. \n

  2. IsSendEmail (boolean, optional): Flag indicating whether to send an email notification to the user.

    \n
    3. \n

  3. PhoneNumber (string, optional): Updated phone number for SMS notification. A valid format for the Phone number is Country code + Phone number.

    \n
    4. \n

  4. Email (string, optional): Updated email address for email notification.

    \n
    5. \n
\n

Response Notes

\n

A successful request will have an HTTP 200 OK response and the image request will be resent with updated notification preferences.

\n","urlObject":{"protocol":"https","path":["v1","imagerequest","{{imageRequestId}}","resend"],"host":["cryptostipsapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"30748090-4950-463c-8934-cc1a6d675602","name":"Resend Image Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"isSendSMS\": false,\r\n \"isSendEmail\": true,\r\n \"PhoneNumber\": \"+11234567890\",\r\n \"Email\": \"customer+updated@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptostipsapi.edocs.co/v1/imagerequest/{{imageRequestId}}/resend"},"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":"Strict-Transport-Security","value":"max-age=2592000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 03 Apr 2024 10:17:22 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"imageRequestId\": \"{imageRequestId}\",\n \"imageRequestLink\": \"https://cryptostips.edocs.co/uploadstips?t=abc123xyz\",\n \"linkValidity\": \"2024-04-06T10:17:22.6735525Z\"\n}"}],"_postman_id":"c05e72ba-3e20-4b22-b712-85960238006c"},{"name":"Get Image Request Documents","id":"c0b7d97c-529d-4386-b011-405ee80b9c5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://cryptostipsapi.edocs.co/v1/imagerequest/{{imageRequestId}}","description":"

This endpoint allows you to get the status, details, and uploaded Image Request Document from the Id of Create Image Request. You will need to place the Image Request Id at the endpoint URL before the documents section.

\n

Response Notes

\n

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

\n
    \n

  1. imageRequestId -This is a reference to the Image Request Id you used in this request.

    \n
    2. \n

  2. Status - This refers to the current state of the activity done with the Image Request Link. Available status values are Viewed, Completed.

    \n
    3. \n

  3. DateCreated - This contains the date and time stamp to which the Image Request link was submitted.

    \n
    4. \n

  4. DateCompleted - This contains the date and time stamp to which the Image Request link was completed.

    \n
    5. \n

  5. Documents - This is the list of documents you have included on your CryptoStips API request. This section may contain single or multiple set of documents. The Documents section contains the following elements:

    \n
      \n

    1. DocumentId - This is a unique identifier of the Document.

      \n
      2. \n

    2. Name - This is a reference to the type of document you have set on your CryptoStips API request.

      \n
      3. \n

    3. FileName - This is a reference to the custom filename you have set on your CryptoStips API request.

      \n
      4. \n

    4. DownloadURI - This is the generated download URL link of the document that you will need to be able to download Image Request Document. See Download Documentfor more details.

      \n
      5. \n
    \n
    6. \n

  6. CustomFields - These are additional details associated with the Create Image Request. It has two elements:

    \n
      \n
    1. Name - This is the name of the variable that was set.
      2. \n
    2. Value - The value of the variable you set from the Name element.
      3. \n
    \n
    7. \n
\n","urlObject":{"protocol":"https","path":["v1","imagerequest","{{imageRequestId}}"],"host":["cryptostipsapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"186e04cb-9cb0-447b-973e-18eb87d5c7df","name":"Get Image Request Documents","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://cryptostipsapi.edocs.co/v1/imagerequest/{{imageRequestId}}"},"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":"Strict-Transport-Security","value":"max-age=2592000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 03 Apr 2024 10:35:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"imageRequestId\": \"{imageRequestId}\",\n \"status\": \"Completed\",\n \"dateCreated\": \"2024-04-03T09:40:20.583\",\n \"dateCompleted\": \"2024-04-03T10:18:14.67\",\n \"documents\": [\n {\n \"documentId\": \"{documentId}\",\n \"name\": \"Driver's License\",\n \"fileName\": \"Drivers-License.jpg\",\n \"downloadUri\": \"https://cryptostipsapi.edocs.co/v1/imagerequest/{imageRequestId}/download/{documentId}\"\n },\n {\n \"documentId\": \"{documentId}\",\n \"name\": \"Passport\",\n \"fileName\": \"Passport.jpg\",\n \"downloadUri\": \"https://cryptostipsapi.edocs.co/v1/imagerequest/{imageRequestId}/download/{documentId}\"\n },\n {\n \"documentId\": \"{documentId}\",\n \"name\": \"Payslip\",\n \"fileName\": \"Payslip.jpg\",\n \"downloadUri\": \"https://cryptostipsapi.edocs.co/v1/imagerequest/{imageRequestId}/download/{documentId}\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"CustomerName\",\n \"value\": \"John Wick\"\n },\n {\n \"name\": \"EmpId\",\n \"value\": \"1234\"\n }\n ]\n}"}],"_postman_id":"c0b7d97c-529d-4386-b011-405ee80b9c5d"},{"name":"Download Document","id":"f7da50e1-f2b9-4c01-917b-026e15da04e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://cryptostipsapi.edocs.co/v1/imagerequest/{{imageRequestId}}/download/{{documentId}}","description":"

This endpoint allows you to download a single document using the downloadURI element from Get Documents endpoint. You will need to place the downloadURI value on the URL of this request.

\n

Response Notes

\n

A successful request will have an HTTP 200 OK response with a body containing the uploaded document.

\n","urlObject":{"protocol":"https","path":["v1","imagerequest","{{imageRequestId}}","download","{{documentId}}"],"host":["cryptostipsapi","edocs","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7da50e1-f2b9-4c01-917b-026e15da04e7"}],"event":[{"listen":"prerequest","script":{"id":"08e7757c-c81a-42a6-aea5-3fa540df19b4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bb423e0d-1499-4912-abb8-3dd98edaa5d8","type":"text/javascript","exec":[""]}}]}