Retrieve customer detail

How to retrieve customer details on AYAN PDF?

User can retrieve details of an existing customer using two ways:

  1. Login via AYAN PDF: User can navigate to “AYAN PDF” page and can click a button (on top right corner) “Login” to login to an existing account for AYAN PDF. Once the login information is filled up, it will redirect user on to dashboard page of AYAN PDF account.
  2. Using AYAN Retrieve Customer API: User can use the retrieve customer api of AYAN PDF to retrieve the details for any existing customer of AYAN PDF. Once the request is made with all the required information, the api will return the customer details in the callout response.


Parameter Value Description
Endpoint URL The API endpoint url on which request will be sent
Method POST Set the Callout method as POST
Content-Type application/json Set “application/json” as content type for this request
Request Body (JSON)





All the information in the JSON Body are mandatory. Each attribute represents as below:

  1. username – customer’s email with which customer account was created (Required)
  2. password – a password set for the customer account (Required)
Response with Code =1 {
“message”: “ok”,
“data”: {
“customer_name”: “Mohit Bansal”,
“company_name”: “AYAN Softwares”,
“company_address”: “NIT Faridabad”,
“username”: “”,
“active_plan”: “Free”,
“storage_location”: “asia”,
“account_status”: “active”,
“companyInformationkeys”: [
“start_date”: “2023-02-06T04:49:31.822Z”,
“end_date”: “2023-02-13T04:49:31.822Z”,
“key_code”: “<<API Key Code>>”,
“token”: “<<Token>>”,
“total_connects”: 50,
“connects_used”: 6,
“connects_remaining”: 44,
“key_type”: “Free”}
“code”: 1
If the response “code” is 1, then it represents your request is successfully submitted and api returns the below the parameters:

  • Basic Customer Details
    • Customer name – the name of the customer
    • Company name – the name of the customer ‘s company
    • Company Address – the customer’s address information
    • Username / Email – the customer email
    • Current Plan (Free or Paid) – it defines the type of the plan for which the customer is registered
    • S3 Storage Location – it defines the S3 server location where the final merged files are stored
    • Account Status – it defines when the customer account is active or expired
  • Active Key Information
    • Key Start Date – Date on which API key was activated
    • Key End Date – Date on which the API key will expire
    • Key Code – API Key which is used to make any api callouts to merge files
    • Token – API key along with the token is required to make any api callout for merging files
    • Total Connects – Every connect represent a file. So the number of connects defines the number of files which a customer can merge in its API key duration. The api key duration defines the time for which the api key is active.
    • Connects Used – it defines the number of connects which are already used for merging the files
    • Connect Remaining – it defines the number of connects which are remaining
    • Key Type – defines whether the key is free or paid


Response with code=0 {
“message”: “error”,
“data”: {
“message”: “Invalid customer information.”
“code”: 0
  • If “code” is 0 with message=”error”, then it represents your request is failed due to either of below reasons:
    • “Invalid Username” – The Customer doesn’t exists in the system with this email”
    • “Invalid Password details” – the password doesn’t matches with the customer password.


An API Key is must to use any API on AYAN PDF. If you are facing any issues in retrieve account or finding an api key, you can reach us at

This tool is available on Appexchange and Click on below button to install the
latest version of BOFC

or learn more

Leave a Reply

Your email address will not be published. Required fields are marked *

Think you know Salesforce?
Fill in the details to Get Started

Which of the following statements are true about resetting passwords when users get locked out of a Salesforce org that does NOT have single sign-on enabled through an identity service other than Salesforce?

Which of the following can a Case Queue be used for?

What is true about dynamic dashboards?

A Salesforce Administrator has 7 million records that need to be loaded into Salesforce and wants to do it in one batch. How can the records be uploaded in one batch?

If a user is working in Salesforce when the login hours end, what will happen?

Your score is


This will close in 0 seconds