AEPSUserOnBoarding

Post  https://api.aopay.co.in/api/AOP/V1/AEPS/AEPSUserOnBoarding

The AEPSUserOnBoarding API is used to onboard a user for AEPS (Aadhaar Enabled Payment System) services. Onboarding generates an agent code which uniquely identifies the user/agent for AEPS transactions such as balance inquiry, withdrawal, and deposits.

Note:All parameters that contain image values must be converted into Base64 format before hitting the API. Do not send raw image files or file paths.

Body Parameters
{
  "Name": "John",
  "Gender": "Male",
  "DOB": "2025-11-23",
  "EmailID": "john.tes@example.com",
  "MobileNumber": "97XXXXXXXX",
  "AltPhoneNumber": "97XXXXXXXX",
  "Address": "123 Main St",
  "District": "district_code",
  "State": "state_code",
  "Pincode": "123456",
  "LandMark": "Near City Park",
  "Pancardnumber": "ABCDE1234F",
  "Aadharnumber": "123456789012",
  "Kyctype": "PAN",
  "Companyname": "John Retail",
  "Shopname": "John Store",
  "Orgaddress": "123 Main St, Suite 101",
  "Orgcity": "Anytown",
  "Orgdistrict": "district_code",
  "Orgpincode": "543210",
  "Shoparea": "Near City Park",
  "Gstnumber": "27ABCDE1234F1Z5",
  "Mcc": "mcc_code",
  "Compan": "ABCDE1234F",
  "Accounttype": "Savings",
  "Accountnumber": "1234567890",
  "Bankname": "Example Bank",
  "Ifsccode": "EXAB0000000",
  "Bank_pincode": "123456",
  "Branchname": "Main Branch",
  "Holdername": "John",
  "Tannumber": "MUMR12345B",
  "Orgpannumber": "XYZ1234567",
  "Maskadimg": "masked_aadhar_image.jpg", 
  "Adfrontimg": "aadhar_front_image.jpg",
  "Adbackimg": "aadhar_back_image.jpg",
  "Pancardimg": "pan_card_image.jpg",
  "Shopimg": "shop_image.jpg",
  "Chequeimg": "cancelled_cheque_image.jpg",
  "Shoplicenseimage": "Shoplicense_image.jpg",
  "Profileimg": "Profile_image.jpg",
  "Latitude": "37.7749",
  "Longitude": "-122.4194",
  "Pipe": "bank6",
  "RegistrationID": "AOP-554"
}

Note: All image parameters under AEPSUserOnBoarding must be provided in Base64 format.

Request Parameters
Name Type Description
Name String Retailer’s Full Name (include both first name and last name.)
Gender String Male/Female/Other.
DOBStringRetailer's Date of Birth (YYYY-MM-DD).
Responses

200

200

Response

200

RESPONSE BODY

Json

401

401

Response

401

RESPONSE BODY

Object

status     boolean

response_code     integer

message     string

Did this page help you?     Yes    No

Language
shell Shell
python Python
node Node
c# C#
php PHP

cURL

curl --location 'https://api.aopay.co.in/api/AOP/V1/AEPS/AEPSUserOnBoarding' \
--header 'Content-Type: application/json' \
--data  '{
  "Name": "John",  
  "Gender": "Male",  
  "DOB": "2025-11-23",  
  "EmailID": "john.tes@example.com",  
  "MobileNumber": "97XXXXXXXX",  
  "AltPhoneNumber": "97XXXXXXXX",  
  "Address": "123 Main St",  
  "District": "district_code",  
  "State": "state_code",  
  "Pincode": "123456",  
  "LandMark": "Near City Park",  
  "Pancardnumber": "ABCDE1234F",  
  "Aadharnumber": "123456789012",  
  "Kyctype": "PAN",  
  "Companyname": "John Retail",  
  "Shopname": "John Store",  
  "Orgaddress": "123 Main St, Suite 101",  
  "Orgcity": "Anytown",  
  "Orgdistrict": "district_code",  
  "Orgpincode": "543210",  
  "Shoparea": "Near City Park",  
  "Gstnumber": "27ABCDE1234F1Z5",  
  "Mcc": "mcc_code",  
  "Compan": "ABCDE1234F",  
  "Accounttype": "Savings",  
  "Accountnumber": "1234567890",  
  "Bankname": "Example Bank",  
  "Ifsccode": "EXAB0000000",  
  "Bank_pincode": "123456",  
  "Branchname": "Main Branch",  
  "Holdername": "John",  
  "Tannumber": "MUMR12345B",  
  "Orgpannumber": "XYZ1234567",  
  "Maskadimg": "masked_aadhar_image.jpg",  
  "Adfrontimg": "aadhar_front_image.jpg",  
  "Adbackimg": "aadhar_back_image.jpg",  
  "Pancardimg": "pan_card_image.jpg",  
  "Shopimg": "shop_image.jpg",  
  "Chequeimg": "cancelled_cheque_image.jpg",  
  "Shoplicenseimage": "Shoplicense_image.jpg",  
  "Profileimg": "Profile_image.jpg",  
  "Latitude": "37.7749",  
  "Longitude": "-122.4194",  
  "Pipe": "bank6",  
  "RegistrationID": "AOP-554"  
}'
                                
import requests
import json

url = 'https://api.aopay.co.in/api/AOP/V1/AEPS/AEPSUserOnBoarding'
payload = json.dumps({
"Name": "John",  
"Gender": "Male",  
"DOB": "2025-11-23",  
"EmailID": "john.tes@example.com",  
"MobileNumber": "97XXXXXXXX",  
"AltPhoneNumber": "97XXXXXXXX",  
"Address": "123 Main St",  
"District": "district_code",  
"State": "state_code",  
"Pincode": "123456",  
"LandMark": "Near City Park",  
"Pancardnumber": "ABCDE1234F",  
"Aadharnumber": "123456789012",  
"Kyctype": "PAN",  
"Companyname": "John Retail",  
"Shopname": "John Store",  
"Orgaddress": "123 Main St, Suite 101",  
"Orgcity": "Anytown",  
"Orgdistrict": "district_code",  
"Orgpincode": "543210",  
"Shoparea": "Near City Park",  
"Gstnumber": "27ABCDE1234F1Z5",  
"Mcc": "mcc_code",  
"Compan": "ABCDE1234F",  
"Accounttype": "Savings",  
"Accountnumber": "1234567890",  
"Bankname": "Example Bank",  
"Ifsccode": "EXAB0000000",  
"Bank_pincode": "123456",  
"Branchname": "Main Branch",  
"Holdername": "John",  
"Tannumber": "MUMR12345B",  
"Orgpannumber": "XYZ1234567",  
"Maskadimg": "masked_aadhar_image.jpg",  
"Adfrontimg": "aadhar_front_image.jpg",  
"Adbackimg": "aadhar_back_image.jpg",  
"Pancardimg": "pan_card_image.jpg",  
"Shopimg": "shop_image.jpg",  
"Chequeimg": "cancelled_cheque_image.jpg",  
"Shoplicenseimage": "Shoplicense_image.jpg",  
"Profileimg": "Profile_image.jpg",  
"Latitude": "37.7749",  
"Longitude": "-122.4194",  
"Pipe": "bank6",  
"RegistrationID": "AOP-554" 
}) 

headers = {
  "Content-type" : "application/json"
}

response = requests.request("POST" url, headers=headers, data=payload)

print (response.text)
                                
var requests = require("request");
var options = { 
  "method" : "POST",
  "url" : 'https://api.aopay.co.in/api/AOP/V1/AEPS/AEPSUserOnBoarding',
  "headers" : {
    "Content-Type" : 'application/json'
  },
  body: JSON.stringify({
"Name": "John",  
"Gender": "Male",  
"DOB": "2025-11-23",  
"EmailID": "john.tes@example.com",  
"MobileNumber": "97XXXXXXXX",  
"AltPhoneNumber": "97XXXXXXXX",  
"Address": "123 Main St",  
"District": "district_code",  
"State": "state_code",  
"Pincode": "123456",  
"LandMark": "Near City Park",  
"Pancardnumber": "ABCDE1234F",  
"Aadharnumber": "123456789012",  
"Kyctype": "PAN",  
"Companyname": "John Retail",  
"Shopname": "John Store",  
"Orgaddress": "123 Main St, Suite 101",  
"Orgcity": "Anytown",  
"Orgdistrict": "district_code",  
"Orgpincode": "543210",  
"Shoparea": "Near City Park",  
"Gstnumber": "27ABCDE1234F1Z5",  
"Mcc": "mcc_code",  
"Compan": "ABCDE1234F",  
"Accounttype": "Savings",  
"Accountnumber": "1234567890",  
"Bankname": "Example Bank",  
"Ifsccode": "EXAB0000000",  
"Bank_pincode": "123456",  
"Branchname": "Main Branch",  
"Holdername": "John",  
"Tannumber": "MUMR12345B",  
"Orgpannumber": "XYZ1234567",  
"Maskadimg": "masked_aadhar_image.jpg",  
"Adfrontimg": "aadhar_front_image.jpg",  
"Adbackimg": "aadhar_back_image.jpg",  
"Pancardimg": "pan_card_image.jpg",  
"Shopimg": "shop_image.jpg",  
"Chequeimg": "cancelled_cheque_image.jpg",  
"Shoplicenseimage": "Shoplicense_image.jpg",  
"Profileimg": "Profile_image.jpg",  
"Latitude": "37.7749",  
"Longitude": "-122.4194",  
"Pipe": "bank6",  
"RegistrationID": "AOP-554" 
  }) 
}; 
request(options, function(error, response){
   if(error) throw new Error(error);
   console.log(response.body); 
}); 
                                
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post,'https://api.aopay.co.in/api/AOP/V1/AEPS/AEPSUserOnBoarding')
var content = new StringContent(
  "{
"Name": "John",  
"Gender": "Male",  
"DOB": "2025-11-23",  
"EmailID": "john.tes@example.com",  
"MobileNumber": "97XXXXXXXX",  
"AltPhoneNumber": "97XXXXXXXX",  
"Address": "123 Main St",  
"District": "district_code",  
"State": "state_code",  
"Pincode": "123456",  
"LandMark": "Near City Park",  
"Pancardnumber": "ABCDE1234F",  
"Aadharnumber": "123456789012",  
"Kyctype": "PAN",  
"Companyname": "John Retail",  
"Shopname": "John Store",  
"Orgaddress": "123 Main St, Suite 101",  
"Orgcity": "Anytown",  
"Orgdistrict": "district_code",  
"Orgpincode": "543210",  
"Shoparea": "Near City Park",  
"Gstnumber": "27ABCDE1234F1Z5",  
"Mcc": "mcc_code",  
"Compan": "ABCDE1234F",  
"Accounttype": "Savings",  
"Accountnumber": "1234567890",  
"Bankname": "Example Bank",  
"Ifsccode": "EXAB0000000",  
"Bank_pincode": "123456",  
"Branchname": "Main Branch",  
"Holdername": "John",  
"Tannumber": "MUMR12345B",  
"Orgpannumber": "XYZ1234567",  
"Maskadimg": "masked_aadhar_image.jpg",  
"Adfrontimg": "aadhar_front_image.jpg",  
"Adbackimg": "aadhar_back_image.jpg",  
"Pancardimg": "pan_card_image.jpg",  
"Shopimg": "shop_image.jpg",  
"Chequeimg": "cancelled_cheque_image.jpg",  
"Shoplicenseimage": "Shoplicense_image.jpg",  
"Profileimg": "Profile_image.jpg",  
"Latitude": "37.7749",  
"Longitude": "-122.4194",  
"Pipe": "bank6",  
"RegistrationID": "AOP-554" 
  }",
  null,"application/json"
); 

request.Content = content;
var response =  await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
                                
<?php
$curl =  curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL =>  'https://api.aopay.co.in/api/AOP/V1/AEPS/AEPSUserOnBoarding',
  CURLOPT_RETURNTRANSFER =>  true,
  CURLOPT_ENCODING =>  '',
  CURLOPT_MAXREDIRS =>  10,
  CURLOPT_TIMEOUT =>  0,
  CURLOPT_FOLLOWLOCATION =>  true,
  CURLOPT_HTTP_VERSION =>  CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =>  'POST',
  CURLOPT_POSTFIELDS =>  '{
"Name": "John",  
"Gender": "Male",  
"DOB": "2025-11-23",  
"EmailID": "john.tes@example.com",  
"MobileNumber": "97XXXXXXXX",  
"AltPhoneNumber": "97XXXXXXXX",  
"Address": "123 Main St",  
"District": "district_code",  
"State": "state_code",  
"Pincode": "123456",  
"LandMark": "Near City Park",  
"Pancardnumber": "ABCDE1234F",  
"Aadharnumber": "123456789012",  
"Kyctype": "PAN",  
"Companyname": "John Retail",  
"Shopname": "John Store",  
"Orgaddress": "123 Main St, Suite 101",  
"Orgcity": "Anytown",  
"Orgdistrict": "district_code",  
"Orgpincode": "543210",  
"Shoparea": "Near City Park",  
"Gstnumber": "27ABCDE1234F1Z5",  
"Mcc": "mcc_code",  
"Compan": "ABCDE1234F",  
"Accounttype": "Savings",  
"Accountnumber": "1234567890",  
"Bankname": "Example Bank",  
"Ifsccode": "EXAB0000000",  
"Bank_pincode": "123456",  
"Branchname": "Main Branch",  
"Holdername": "John",  
"Tannumber": "MUMR12345B",  
"Orgpannumber": "XYZ1234567",  
"Maskadimg": "masked_aadhar_image.jpg",  
"Adfrontimg": "aadhar_front_image.jpg",  
"Adbackimg": "aadhar_back_image.jpg",  
"Pancardimg": "pan_card_image.jpg",  
"Shopimg": "shop_image.jpg",  
"Chequeimg": "cancelled_cheque_image.jpg",  
"Shoplicenseimage": "Shoplicense_image.jpg",  
"Profileimg": "Profile_image.jpg",  
"Latitude": "37.7749",  
"Longitude": "-122.4194",  
"Pipe": "bank6",  
"RegistrationID": "AOP-554" 
  }',
  CURLOPT_HTTPHEADER =>  array(
    'Content-Type: application/json'
  ),
));
$response =  curl_exec($curl);
curl_close($curl);
echo $response;

RESPONSE

200

401

-Result

Example

{
    "status": true,
    "msg": "User onboarded successfully",
         "data": {
                "message": "User created successfully",
                "aepsurl": "",
                "agent_code": "AG00002XXX"
         },
        "statusCode": 200,
        "userkey": "AOP554N3XXXXX",
        "Status": "True",
        "message": "User onboarded successfully",
        "Value": ""
}
                                
{
  "status": false,
  "response_code": 5,
  "message": "Invalid signature encoding"
}