Skip to main content
POST
/
api
/
v1
/
employee
/
consent-data
Submit Employee Consent Data
curl --request POST \
  --url https://{env}.tartanhq.com/api/v1/employee/consent-data/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org": "9e3ba089-5cb6-407c-93db-e3b7ccaff3ed",
  "employee_id": "0078",
  "consent_language": "I have new consent.",
  "consent_timestamp": "2024-11-20T10:30:00Z",
  "consent_expiry": "2024-11-28T10:30:00Z"
}
'
{
  "requestId": "d4e04a3f-08c2-45bd-a7de-ea37fc632a1f",
  "message": "success",
  "data": {
    "id": "7",
    "employeeId": "5",
    "name": "Manas Mallik",
    "email": "manas@tartanhq.com",
    "personalEmail": "manas.mallik@gmail.com",
    "doj": "2021-06-01",
    "dob": "1983-06-08",
    "status": "Active",
    "employmentType": "Permanent",
    "gender": "Male",
    "pan": "************",
    "aadhar": "************",
    "uan": "************",
    "mobileNumber": "************",
    "maritalStatus": "Married",
    "nationality": "Indian",
    "fatherName": "Ritesh Mallik",
    "bloodGroup": "AB +ve",
    "designation": "NOT AVAILABLE",
    "department": "Engineering",
    "grade": "D-3",
    "groupName": "NOT AVAILABLE",
    "costCenter": "NOT AVAILABLE",
    "companyName": "NOT AVAILABLE",
    "terminationDate": "",
    "manager": "Meet Semlani",
    "managerEmail": "NOT AVAILABLE",
    "managerEmail2": "NOT AVAILABLE",
    "managerEmail3": "NOT AVAILABLE",
    "managerEmail4": "NOT AVAILABLE",
    "managerEmail5": "NOT AVAILABLE",
    "countryCode": "IN",
    "bankDetails": {
      "accountNumber": "************",
      "ifscCode": "************",
      "bankName": "SBI"
    },
    "currentAddress": {
      "addressPincode": "560080",
      "addressCity": "Banglore",
      "addressCountry": "India",
      "addressState": "Karnataka",
      "addressLine": "Sadashiva Nagar Armane Nagar"
    },
    "permanentAddress": {
      "addressPincode": "226001",
      "addressCity": "Luknow",
      "addressCountry": "India",
      "addressState": "Uttar Pradesh",
      "addressLine": "Yarana Nagar Luknow"
    },
    "jobLocation": {
      "pincode": "NOT AVAILABLE",
      "city": "NOT AVAILABLE"
    },
    "employeeMetadata": {
      "marriageDate": "NOT AVAILABLE"
    },
    "dependentDetails": [
      {
        "name": "Sohan Negi",
        "relation": "Father",
        "dob": "NOT AVAILABLE",
        "email": "NOT AVAILABLE",
        "gender": "NOT AVAILABLE",
        "mobileNumber": "NOT AVAILABLE",
        "profession": "NOT AVAILABLE"
      }
    ],
    "salaryDetails": {
      "ctc": {
        "basic": 50000,
        "dearnessAllowance": 9000.9,
        "hra": 25000.5,
        "gratuity": 2000.7,
        "medicalAllowance": 2000.7,
        "travelAllowance": 2000.7,
        "specialAllowance": null,
        "otherAllowance": null,
        "flexiBasketAllowance": null,
        "grossPay": null,
        "taxRegime": null,
        "fixedPay": null,
        "bonus": {
          "joining": 80000,
          "referral": null,
          "retention": null,
          "performance": null,
          "relocation": null,
          "misc": null
        },
        "deductions": {
          "pf": 1800,
          "esi": null,
          "professionalTax": null,
          "labourWelfareFund": null,
          "misc": null,
          "nps": null
        }
      },
      "monthly": {
        "month": 2,
        "year": 2025,
        "basic": null,
        "dearnessAllowance": null,
        "hra": null,
        "medicalAllowance": null,
        "travelAllowance": null,
        "specialAllowance": null,
        "flexiBasketAllowance": null,
        "gratuity": 1600,
        "otherAllowance": null,
        "taxRegime": null,
        "fixedPay": null,
        "grossPay": null,
        "bonus": {
          "joining": 20000,
          "referral": null,
          "retention": null,
          "performance": null,
          "relocation": 28907.17,
          "misc": null
        },
        "deductions": {
          "pf": null,
          "esi": null,
          "professionalTax": 300,
          "labourWelfareFund": null,
          "tds": null,
          "medicalClaimDeduction": null,
          "groupTermInsuranceDeductions": null,
          "earlyWageDeduction": null,
          "misc": 162023.24,
          "nps": 1234.34
        },
        "reimbursements": 93321.33
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
org
string<uuid>
required

Organization UUID

Example:

"9e3ba089-5cb6-407c-93db-e3b7ccaff3ed"

​
employee_id
string
required

Unique employee ID within the organization

Example:

"0078"

​
consent_language
string
required

Consent statement or text given by the employee

Example:

"I have new consent."

​
consent_timestamp
string<date-time>
required

Timestamp when the consent was given

Example:

"2024-11-20T10:30:00Z"

​
consent_expiry
string<date-time>
required

Consent expiration datetime

Example:

"2024-11-28T10:30:00Z"

Response

Employee details retrieved successfully

​
requestId
string
Example:

"d4e04a3f-08c2-45bd-a7de-ea37fc632a1f"

​
message
string
Example:

"success"

​
data
object