✨API Docs

Get your API Auth Token

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can get your API Auth Token from your partner at Vouch or write to [e-mail]

Check the AuthToken

To make sure that your AuthToken is valid, you can use this API :

GET api.vouch.social/api/corporate/check-auth

Options

curl

curl --location 'https://api.vouch.social/api/corporate/check-auth' \
--header 'Authorization: Bearer <AuthToken>'

Response

200 | AuthToken Valid

{
    "message": "success",
    "data": [],
    "status": true,
    "meta": null
}

401 Permission denied

Good to know: If you believe you have inadvertently received a 401 error or you need any other information, please write to [e-mail]

---

SaveCustomers

Save your customers on Vouch who can help with lead conversion & share referral bonuses:

POST api.vouch.social/api/corporate/save-customer

Request

Request

{
    "customers": [
        {
            "customerId": "CUST001",
            "contactHashedPhone": "d90743216eef2200d6c2ca4231e8b1857ecfe3ee0f8c0d38634c0c35bfd996ff"
        },
        {
            "customerId": "CUST002",
            "contactHashedPhone": "9e999284194d1cafb5bd736b55de4651d5cb4fa0e06743d3dce2ec73f2cd4f04"
        }
    ]
}

Name	Type	Description
customerId	string	Unique Identifier of the customer at your side
contactHashedPhone	string	The <hash> of the phoner number of the customer

Response

200 | Save Customer Successful

{
    "message": "success",
    "data": {
        "corpCustomersData": {
            "totalRecordsRecieved": 2,
            "totalRecordsCreated": 0,
            "totalRecordsUpdated": 2,
            "totalRecordsSkipped": 0
        }
    },
    "status": true,
    "meta": null
}

4xx | Error

totalRecordsRecieved	int	Number of customers shared in the call
totalRecordsCreated	int	Number of records new created on Vouch
totalRecordsUpdated	int	Number of old records updated on Vouch. PS : CustomerID is updated, customerHashedPhone is unique at Vouch
totalRecordsSkipped	int	Number of records skipped which don't match the format

<hash>: Hashing transforms input data into a fixed-size string of characters using a hash function, ensuring data integrity and security. Hash is always to be done of the 10-digit Indian Phone Number with 91 at the start

Expected Format : 919076576578

ManualCheck

Use Input : 9199999999 OutPut : 5a15bf8887c41bb21f3b33a5bf1a06064711a6495cbbd97ddb92995d5df8b1b5 Link : https://codebeautify.org/sha256-hash-generator

Python

JavaScript

---

Check Lead

To check the connectivity of a lead, use this API :

POST https://api.vouch.social/api/corporate/check-lead

Request

Request

{
    "leadHashedPhone": "5a15bf8887c41bb21f3b33a5bf1a06064711a6495cbbd97ddb92995d5df8b1b5"
}

Second Tab

Name	Type	Description
leadHashedPhone*	string	The <hash> of the lead which you want to check with Vouch

Response

200 | AuthToken Valid

{
    "message": "success",
    "data": {
        "customerData": [
            {
                "name": "Nirant Ramakuru",
                "hashedPhone": "D90743216EEF2200D6C2CA4231E8B1857ECFE3EE0F8C0D38634C0C35BFD996FF",
                "strength": 3,
                "customerId": "CUST014",
                "isRegistered": true
            },
            {
                "name": "Anushtha Jain",
                "hashedPhone": "8576CC8DB8DFAAF46CCBCD300EBD79F5AB8936CF2AAEDB8DEFDCCADC53F6DF21",
                "strength": 8,
                "customerId": "CUST016",
                "isRegistered": true
            },
            {
                "name": "Ekaa",
                "hashedPhone": "92B5072176E723878B5E06FF3CA61898E4EB74E8C46642A0F2DB800B17364AB0",
                "strength": 20,
                "customerId": "CUST026",
                "isRegistered": true
            },
            {
                "hashedPhone": "9DD515FE4124AD44D2F3E28500F60F8A56F1150F29A22CEAA78AFBE70D5D0B2A",
                "strength": 30,
                "customerId": "CUST007",
                "isRegistered": false
            }
        ]
    },
    "status": true,
    "meta": null
}

401 Permission denied

Name	Type	Description
name	string	If Customer is registered on Vouch, then we'll share the name
hashedPhone	string	hashedPhone of the customer who is related to the lead
strength	int	The strength of connection between the lead & the customer shared

Strength : Strength can range from 1 to ♾️.. but we see the realistic limit as being ~500. Higher the strength, the better the chance of getting a referral

Save Contacts

To upload the contactList of registered User, use this API :

POST https://api.vouch.social/api/contacts/saveContacts

Request

Request

{
"hashedPhone": "ce3a598687c8d2e5aa6bedad20e059b4a78cca0adad7e563b07998d5cd226b8c",
    "contacts": [
        {
            "displayName": "Aakansha Antino",
            "phones": [
                {
                    "hashedPhone": "ce3a598687c8d2e5aa6bedad20e059b4a78cca0adad7e563b07998d5cd226b8c"
                }
            ]
        }
    ]
}

Name	Type	Description
hashedPhone*	string	The <hash> of the registered user whose contactList is being uploaded
contacts*	Array	The list of contacts of the registered user
displayName	string	The name of the contact as stored by the registered user in their contacts
phones	Array	The list of phoneNumbers (hashed) for the contact
hashedPhone	string	The <hash> of the contact

Response

200 | Success

{
    "message": "Contacts processed successfully",
    "data": {
        "totalRecordsRecieved": 1,
        "totalRecordsCreated": 0,
        "totalRecordsUpdated": 0,
        "totalRecordsSkipped": 0,
        "lastSync": "11/12/2024"
    },
    "status": true,
    "meta": null
}

401 Permission denied

Name	Type	Description
totalRecordsRecieved	int	Total Contacts Received
totalRecordsCreated	int	Total Contacts Created New
totalRecordsUpdated	int	Total Contacts Updated for Name
totalRecordsSkipped		Total Contacts Skipped due to data mismatch or existing data