API for payroll providers to integrate with Aslan. This API enables payroll providers to manage company registrations and employee onboarding for Aslan services.
- Retrieve complete employee details
Retrieve all employees for a company
Create new employee
Update employee information
Send invitations to employees
Retrieve complete employe...
Partner API (0.0.1)
Download OpenAPI description
Languages
Servers
Mock server
https://developer.aslan.io/_mock/openapi/
https://uat.partner.aslan.io/api/v1/
https://partner.aslan.io/api/v1/
Request
Returns a paginated, summarized list of all employees registered under a specific company with Aslan. This endpoint provides essential employee information without sensitive or detailed fields. Supports filtering by status, role, and date ranges, plus sorting capabilities.
Security
partnerAdminAuth
- Mock serverhttps://developer.aslan.io/_mock/openapi/companies/{companyId}/users
- https://uat.partner.aslan.io/api/v1/companies/{companyId}/users
- https://partner.aslan.io/api/v1/companies/{companyId}/users
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.aslan.io/_mock/openapi/companies/{companyId}/users?params%5Bsize%5D=20¶ms%5BsortBy%5D=lastName¶ms%5Bsort%5D=asc¶ms%5Bstatus%5D=ACTIVE¶ms%5Brole%5D=EMPLOYEE¶ms%5Bsearch%5D=sarah' \
-H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
-H 'X-Aslan-Timestamp: 1730000000'Successfully retrieved paginated list of employees
List of employee summaries in the current page
Unique system identifier for the employee
Example: "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d"
Current status of the employee with Aslan:
CREATED- Employee record created but invitation not yet sentINVITED- Invitation to join Aslan has been sent to the employeeACTIVE- Employee is actively enrolled and can access earned wage access benefitsDELETED- Employee record has been removed from the systemPAUSED- Employee's access to benefits is temporarily suspendedLEFT- Employee has left the company and is no longer eligible
Enum"CREATED""INVITED""ACTIVE""DELETED""PAUSED""LEFT"
Example: "ACTIVE"
Primary work email address for the employee
Example: "sarah.johnson@techflow.com"
Contact phone number in international format
Example: "+44 7123 456789"
Employee's role within the company and their permission level in Aslan:
EMPLOYEE- Standard employee with access to personal wage access featuresMANAGER- Manager with additional reporting and team oversight capabilitiesADMIN- Company administrator with full company management capabilitiesSUPER_ADMIN- Super administrator with extended system-level permissions
Enum"EMPLOYEE""MANAGER""ADMIN""SUPER_ADMIN"
Example: "EMPLOYEE"
Unique identifier of the company this employee belongs to
Example: "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f"
Human-readable alphanumeric identifier for the employee (max 10 characters)
Example: "F7E6D5C4B3"
Employee identifier from the external payroll system for reconciliation purposes
Example: "PAY-2024-00847"
Response
application/json
{ "content": [ { … } ], "page": 0, "size": 20, "totalElements": 543, "totalPages": 28 }
Bodyapplication/jsonrequired
Primary work email address for the employee
Example: "sarah.johnson@techflow.com"
Secondary or personal email address for account recovery and notifications
Example: "sarah.j.personal@gmail.com"
Contact phone number in international E.164 format
Example: "+447123456789"
Employee identifier from the external payroll system for reconciliation purposes
Example: "PAY-2024-00847"
Employee's annual gross salary in GBP (must be greater than 0)
Example: 45000
Reference to the pay calendar schedule this employee follows
Example: "c5d6e7f8-9a0b-4c5d-8e9f-0a1b2c3d4e5f"
- Mock serverhttps://developer.aslan.io/_mock/openapi/companies/{companyId}/users
- https://uat.partner.aslan.io/api/v1/companies/{companyId}/users
- https://partner.aslan.io/api/v1/companies/{companyId}/users
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.aslan.io/_mock/openapi/companies/{companyId}/users' \
-H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-Aslan-Timestamp: 1730000000' \
-d '{
"firstName": "Sarah",
"lastName": "Johnson",
"email": "sarah.johnson@techflow.com",
"additionalEmail": "sarah.j.personal@gmail.com",
"phoneNumber": "+447123456789",
"externalPayrollId": "PAY-2024-00847",
"annualGrossSalary": 45000,
"startDate": "2024-01-15",
"payCalendarId": "c5d6e7f8-9a0b-4c5d-8e9f-0a1b2c3d4e5f",
"salaried": true
}'Employee successfully created
Unique system identifier for the employee
Example: "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d"
Current status of the employee with Aslan:
CREATED- Employee record created but invitation not yet sentINVITED- Invitation to join Aslan has been sent to the employeeACTIVE- Employee is actively enrolled and can access earned wage access benefitsDELETED- Employee record has been removed from the systemPAUSED- Employee's access to benefits is temporarily suspendedLEFT- Employee has left the company and is no longer eligible
Enum"CREATED""INVITED""ACTIVE""DELETED""PAUSED""LEFT"
Example: "ACTIVE"
Primary work email address for the employee
Example: "sarah.johnson@techflow.com"
Secondary or personal email address for account recovery and notifications
Example: "sarah.j.personal@gmail.com"
Employee's role within the company and their permission level in Aslan:
EMPLOYEE- Standard employee with access to personal wage access featuresMANAGER- Manager with additional reporting and team oversight capabilitiesADMIN- Company administrator with full company management capabilitiesSUPER_ADMIN- Super administrator with extended system-level permissions
Enum"EMPLOYEE""MANAGER""ADMIN""SUPER_ADMIN"
Example: "EMPLOYEE"
Unique identifier of the company this employee belongs to
Example: "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f"
Employee identifier from the external payroll system for reconciliation purposes
Example: "PAY-2024-00847"
Employee's annual gross salary in GBP, used for eligibility calculations
Example: 45000
On-demand pay allowance percentage for wage access eligibility
Example: 25
Historical record of salary changes for the employee
Date and time when the employee was invited to join Aslan
Example: "2024-04-09T09:00:00+00:00"
Date and time when the employee completed registration and joined Aslan
Example: "2024-04-10T11:45:00+00:00"
Employee's employment termination date, if applicable
Example: "2025-03-31"
Reference to the pay calendar schedule this employee follows
Example: "c5d6e7f8-9a0b-4c5d-8e9f-0a1b2c3d4e5f"
Human-readable alphanumeric identifier for the employee (max 10 characters)
Example: "F7E6D5C4B3"
Indicates whether the employee is currently on unpaid leave
Example: false
Indicates whether the employee's email address has been verified
Example: true
Indicates whether the employee's phone number has been verified
Example: true
Flag indicating if the account has been marked for suspicious activity review
Example: false
Indicates whether the employee is on a salaried payment structure
Example: true
Timestamp when the employee was initially registered in the system
Example: "2024-04-08T10:30:00Z"
System identifier of the user or service that created this employee record
Example: "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e"
Timestamp of the most recent update to the employee record
Example: "2024-10-05T11:30:45Z"
System identifier of the user or service that last updated this employee record
Example: "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f"
Timestamp when the employee was soft-deleted from the system
Example: "2024-12-01T16:20:00Z"
Response
application/json
{ "id": "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d", "status": "ACTIVE", "firstName": "Sarah", "lastName": "Johnson", "email": "sarah.johnson@techflow.com", "additionalEmail": "sarah.j.personal@gmail.com", "role": "EMPLOYEE", "companyId": "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f", "phoneNumber": "+44 7123 456789", "externalPayrollId": "PAY-2024-00847", "annualGrossSalary": 45000, "globalAllowancePercentage": 50, "odpAllowancePercentage": 25, "salaryHistory": [ { … } ], "invitedAt": "2024-04-09T09:00:00+00:00", "joinDate": "2024-04-10T11:45:00+00:00", "startDate": "2024-01-15", "terminationDate": "2025-03-31", "payCalendarId": "c5d6e7f8-9a0b-4c5d-8e9f-0a1b2c3d4e5f", "friendlyId": "F7E6D5C4B3", "onUnpaidLeave": false, "emailVerified": true, "phoneNumberVerified": true, "suspicious": false, "salaried": true, "createdAt": "2024-04-08T10:30:00Z", "createdBy": "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e", "updatedAt": "2024-10-05T11:30:45Z", "updatedBy": "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f", "deletedAt": "2024-12-01T16:20:00Z", "deletedBy": "d4e5f6a7-8b9c-6d7e-0f1a-2b3c4d5e6f7a" }
- Mock serverhttps://developer.aslan.io/_mock/openapi/companies/{companyId}/users/{userId}
- https://uat.partner.aslan.io/api/v1/companies/{companyId}/users/{userId}
- https://partner.aslan.io/api/v1/companies/{companyId}/users/{userId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.aslan.io/_mock/openapi/companies/{companyId}/users/{userId}' \
-H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
-H 'X-Aslan-Timestamp: 1730000000'Successfully retrieved complete employee details
Unique system identifier for the employee
Example: "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d"
Current status of the employee with Aslan:
CREATED- Employee record created but invitation not yet sentINVITED- Invitation to join Aslan has been sent to the employeeACTIVE- Employee is actively enrolled and can access earned wage access benefitsDELETED- Employee record has been removed from the systemPAUSED- Employee's access to benefits is temporarily suspendedLEFT- Employee has left the company and is no longer eligible
Enum"CREATED""INVITED""ACTIVE""DELETED""PAUSED""LEFT"
Example: "ACTIVE"
Primary work email address for the employee
Example: "sarah.johnson@techflow.com"
Secondary or personal email address for account recovery and notifications
Example: "sarah.j.personal@gmail.com"
Employee's role within the company and their permission level in Aslan:
EMPLOYEE- Standard employee with access to personal wage access featuresMANAGER- Manager with additional reporting and team oversight capabilitiesADMIN- Company administrator with full company management capabilitiesSUPER_ADMIN- Super administrator with extended system-level permissions
Enum"EMPLOYEE""MANAGER""ADMIN""SUPER_ADMIN"
Example: "EMPLOYEE"
Unique identifier of the company this employee belongs to
Example: "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f"
Employee identifier from the external payroll system for reconciliation purposes
Example: "PAY-2024-00847"
Employee's annual gross salary in GBP, used for eligibility calculations
Example: 45000
On-demand pay allowance percentage for wage access eligibility
Example: 25
Historical record of salary changes for the employee
Date and time when the employee was invited to join Aslan
Example: "2024-04-09T09:00:00+00:00"
Date and time when the employee completed registration and joined Aslan
Example: "2024-04-10T11:45:00+00:00"
Employee's employment termination date, if applicable
Example: "2025-03-31"
Reference to the pay calendar schedule this employee follows
Example: "c5d6e7f8-9a0b-4c5d-8e9f-0a1b2c3d4e5f"
Human-readable alphanumeric identifier for the employee (max 10 characters)
Example: "F7E6D5C4B3"
Indicates whether the employee is currently on unpaid leave
Example: false
Indicates whether the employee's email address has been verified
Example: true
Indicates whether the employee's phone number has been verified
Example: true
Flag indicating if the account has been marked for suspicious activity review
Example: false
Indicates whether the employee is on a salaried payment structure
Example: true
Timestamp when the employee was initially registered in the system
Example: "2024-04-08T10:30:00Z"
System identifier of the user or service that created this employee record
Example: "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e"
Timestamp of the most recent update to the employee record
Example: "2024-10-05T11:30:45Z"
System identifier of the user or service that last updated this employee record
Example: "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f"
Timestamp when the employee was soft-deleted from the system
Example: "2024-12-01T16:20:00Z"
Response
application/json
{ "id": "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d", "status": "ACTIVE", "firstName": "Sarah", "lastName": "Johnson", "email": "sarah.johnson@techflow.com", "additionalEmail": "sarah.j.personal@gmail.com", "role": "EMPLOYEE", "companyId": "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f", "phoneNumber": "+44 7123 456789", "externalPayrollId": "PAY-2024-00847", "annualGrossSalary": 45000, "globalAllowancePercentage": 50, "odpAllowancePercentage": 25, "salaryHistory": [ { … } ], "invitedAt": "2024-04-09T09:00:00+00:00", "joinDate": "2024-04-10T11:45:00+00:00", "startDate": "2024-01-15", "terminationDate": "2025-03-31", "payCalendarId": "c5d6e7f8-9a0b-4c5d-8e9f-0a1b2c3d4e5f", "friendlyId": "F7E6D5C4B3", "onUnpaidLeave": false, "emailVerified": true, "phoneNumberVerified": true, "suspicious": false, "salaried": true, "createdAt": "2024-04-08T10:30:00Z", "createdBy": "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e", "updatedAt": "2024-10-05T11:30:45Z", "updatedBy": "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f", "deletedAt": "2024-12-01T16:20:00Z", "deletedBy": "d4e5f6a7-8b9c-6d7e-0f1a-2b3c4d5e6f7a" }
Bodyapplication/jsonrequired
Updated legal last name of the employee
Example: "Johnson-Smith"
Updated primary work email address
Example: "sarah.johnson-smith@techflow.com"
Updated secondary or personal email address
Example: "sarah.js.new@gmail.com"
Updated contact phone number in international E.164 format
Example: "+447987654321"
Updated employee identifier from the payroll system
Example: "PAY-2024-00847"
Updated annual gross salary in GBP (must be greater than 0)
Example: 48000
- Mock serverhttps://developer.aslan.io/_mock/openapi/companies/{companyId}/users/{userId}
- https://uat.partner.aslan.io/api/v1/companies/{companyId}/users/{userId}
- https://partner.aslan.io/api/v1/companies/{companyId}/users/{userId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.aslan.io/_mock/openapi/companies/{companyId}/users/{userId}' \
-H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-Aslan-Timestamp: 1730000000' \
-d '{
"firstName": "Sarah",
"lastName": "Johnson-Smith",
"email": "sarah.johnson-smith@techflow.com",
"additionalEmail": "sarah.js.new@gmail.com",
"phoneNumber": "+447987654321",
"externalPayrollId": "PAY-2024-00847",
"annualGrossSalary": 48000,
"startDate": "2024-01-15",
"payCalendarId": "c5d6e7f8-9a0b-4c5d-8e9f-0a1b2c3d4e5f"
}'Employee successfully updated
Unique system identifier for the employee
Example: "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d"
Current status of the employee with Aslan:
CREATED- Employee record created but invitation not yet sentINVITED- Invitation to join Aslan has been sent to the employeeACTIVE- Employee is actively enrolled and can access earned wage access benefitsDELETED- Employee record has been removed from the systemPAUSED- Employee's access to benefits is temporarily suspendedLEFT- Employee has left the company and is no longer eligible
Enum"CREATED""INVITED""ACTIVE""DELETED""PAUSED""LEFT"
Example: "ACTIVE"
Primary work email address for the employee
Example: "sarah.johnson@techflow.com"
Secondary or personal email address for account recovery and notifications
Example: "sarah.j.personal@gmail.com"
Employee's role within the company and their permission level in Aslan:
EMPLOYEE- Standard employee with access to personal wage access featuresMANAGER- Manager with additional reporting and team oversight capabilitiesADMIN- Company administrator with full company management capabilitiesSUPER_ADMIN- Super administrator with extended system-level permissions
Enum"EMPLOYEE""MANAGER""ADMIN""SUPER_ADMIN"
Example: "EMPLOYEE"
Unique identifier of the company this employee belongs to
Example: "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f"
Employee identifier from the external payroll system for reconciliation purposes
Example: "PAY-2024-00847"
Employee's annual gross salary in GBP, used for eligibility calculations
Example: 45000
On-demand pay allowance percentage for wage access eligibility
Example: 25
Historical record of salary changes for the employee
Date and time when the employee was invited to join Aslan
Example: "2024-04-09T09:00:00+00:00"
Date and time when the employee completed registration and joined Aslan
Example: "2024-04-10T11:45:00+00:00"
Employee's employment termination date, if applicable
Example: "2025-03-31"
Reference to the pay calendar schedule this employee follows
Example: "c5d6e7f8-9a0b-4c5d-8e9f-0a1b2c3d4e5f"
Human-readable alphanumeric identifier for the employee (max 10 characters)
Example: "F7E6D5C4B3"
Indicates whether the employee is currently on unpaid leave
Example: false
Indicates whether the employee's email address has been verified
Example: true
Indicates whether the employee's phone number has been verified
Example: true
Flag indicating if the account has been marked for suspicious activity review
Example: false
Indicates whether the employee is on a salaried payment structure
Example: true
Timestamp when the employee was initially registered in the system
Example: "2024-04-08T10:30:00Z"
System identifier of the user or service that created this employee record
Example: "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e"
Timestamp of the most recent update to the employee record
Example: "2024-10-05T11:30:45Z"
System identifier of the user or service that last updated this employee record
Example: "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f"
Timestamp when the employee was soft-deleted from the system
Example: "2024-12-01T16:20:00Z"
Response
application/json
{ "id": "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d", "status": "ACTIVE", "firstName": "Sarah", "lastName": "Johnson", "email": "sarah.johnson@techflow.com", "additionalEmail": "sarah.j.personal@gmail.com", "role": "EMPLOYEE", "companyId": "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f", "phoneNumber": "+44 7123 456789", "externalPayrollId": "PAY-2024-00847", "annualGrossSalary": 45000, "globalAllowancePercentage": 50, "odpAllowancePercentage": 25, "salaryHistory": [ { … } ], "invitedAt": "2024-04-09T09:00:00+00:00", "joinDate": "2024-04-10T11:45:00+00:00", "startDate": "2024-01-15", "terminationDate": "2025-03-31", "payCalendarId": "c5d6e7f8-9a0b-4c5d-8e9f-0a1b2c3d4e5f", "friendlyId": "F7E6D5C4B3", "onUnpaidLeave": false, "emailVerified": true, "phoneNumberVerified": true, "suspicious": false, "salaried": true, "createdAt": "2024-04-08T10:30:00Z", "createdBy": "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e", "updatedAt": "2024-10-05T11:30:45Z", "updatedBy": "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f", "deletedAt": "2024-12-01T16:20:00Z", "deletedBy": "d4e5f6a7-8b9c-6d7e-0f1a-2b3c4d5e6f7a" }
Request
Sends invitation emails to one or more employees to join Aslan. This endpoint can be called multiple times - if an employee has already been invited, it will resend the invitation. Can be used for employees in CREATED or INVITED status. Supports batch invitations for multiple employees.
Security
partnerAdminAuth
- Mock serverhttps://developer.aslan.io/_mock/openapi/companies/{companyId}/users/invite
- https://uat.partner.aslan.io/api/v1/companies/{companyId}/users/invite
- https://partner.aslan.io/api/v1/companies/{companyId}/users/invite
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.aslan.io/_mock/openapi/companies/{companyId}/users/invite' \
-H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-Aslan-Timestamp: 1730000000' \
-d '{
"userIds": [
"f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d",
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]
}'Response
application/json
{ "message": "Invitation request accepted for processing", "requestedCount": 2 }