Skip to content

Partner API (0.0.1)

API for payroll providers to integrate with Aslan. This API enables payroll providers to manage company registrations and employee onboarding for Aslan services.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.aslan.io/_mock/openapi/
https://uat.partner.aslan.io/api/v1/
https://partner.aslan.io/api/v1/

Companies

Manage company registrations and details for Aslan enrollment

Operations

Retrieve all companies

Request

Returns a paginated list of all companies registered with Aslan. This endpoint provides an overview of all employer clients in the system with support for filtering and sorting.

Security
partnerAdminAuth
Query
paramsobject(CompanyQueryParams)
Headers
X-Aslan-Timestampinteger(int64)required

Unix epoch timestamp of the request in seconds.

Example: 1730000000
curl -i -X GET \
  'https://developer.aslan.io/_mock/openapi/companies?params%5Bsize%5D=20&params%5BsortBy%5D=name&params%5Bsort%5D=asc&params%5Bstatus%5D=VERIFIED&params%5Bquery%5D=tech' \
  -H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
  -H 'X-Aslan-Timestamp: 1730000000'

Responses

Successfully retrieved paginated list of companies

Bodyapplication/json
contentArray of objects(CompanyResponse)required

List of companies in the current page

content[].​idstring(uuid)required

Unique system identifier for the company

Example: "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f"
content[].​statusstring(CompanyStatus)required

Current registration status of the company with Aslan:

  • VERIFIED - Company is verified and active on the platform
  • DELETED - Company has been removed from the platform (soft delete)
Enum"VERIFIED""DELETED"
Example: "VERIFIED"
content[].​namestringrequired

Registered legal name of the company

Example: "TechFlow Solutions Ltd"
content[].​companyNumberstringrequired

Official company registration number (e.g., Companies House number in the UK)

Example: "09876543"
content[].​addressobject(AddressPayload)
content[].​friendlyIdstring<= 10 charactersrequired

Human-readable alphanumeric identifier for the company (max 10 characters)

Example: "A3F2E1D05C"
content[].​createdAtstring(date-time)required

Timestamp when the company was initially registered in the system

Example: "2024-03-15T10:30:00Z"
content[].​createdBystring(uuid)required

System identifier of the user or service that created this company record

Example: "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e"
content[].​updatedAtstring(date-time)

Timestamp of the most recent update to the company record

Example: "2024-09-20T14:22:15Z"
content[].​updatedBystring(uuid)

System identifier of the user or service that last updated this company record

Example: "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f"
content[].​deletedAtstring(date-time)

Timestamp when the company was soft-deleted from the system

Example: "2024-12-01T09:00:00Z"
content[].​deletedBystring(uuid)

System identifier of the user or service that deleted this company record

Example: "d4e5f6a7-8b9c-6d7e-0f1a-2b3c4d5e6f7a"
pageintegerrequired

Current page number (zero-based)

Example: 0
sizeintegerrequired

Number of items per page

Example: 20
totalElementsintegerrequired

Total number of companies across all pages

Example: 156
totalPagesintegerrequired

Total number of pages

Example: 8
Response
application/json
{
  "content": [
    { … }
  ],
  "page": 0,
  "size": 20,
  "totalElements": 156,
  "totalPages": 8
}

Retrieve company details

Request

Returns detailed information for a specific company, including registration status, company information, and audit trail.

Security
partnerAdminAuth
Path
companyIdstring(uuid)required

The unique identifier for the company

Headers
X-Aslan-Timestampinteger(int64)required

Unix epoch timestamp of the request in seconds.

Example: 1730000000
curl -i -X GET \
  'https://developer.aslan.io/_mock/openapi/companies/{companyId}' \
  -H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
  -H 'X-Aslan-Timestamp: 1730000000'

Responses

Successfully retrieved company details

Bodyapplication/json
idstring(uuid)required

Unique system identifier for the company

Example: "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f"
statusstring(CompanyStatus)required

Current registration status of the company with Aslan:

  • VERIFIED - Company is verified and active on the platform
  • DELETED - Company has been removed from the platform (soft delete)
Enum"VERIFIED""DELETED"
Example: "VERIFIED"
namestringrequired

Registered legal name of the company

Example: "TechFlow Solutions Ltd"
companyNumberstringrequired

Official company registration number (e.g., Companies House number in the UK)

Example: "09876543"
addressobject(AddressPayload)
friendlyIdstring<= 10 charactersrequired

Human-readable alphanumeric identifier for the company (max 10 characters)

Example: "A3F2E1D05C"
createdAtstring(date-time)required

Timestamp when the company was initially registered in the system

Example: "2024-03-15T10:30:00Z"
createdBystring(uuid)required

System identifier of the user or service that created this company record

Example: "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e"
updatedAtstring(date-time)

Timestamp of the most recent update to the company record

Example: "2024-09-20T14:22:15Z"
updatedBystring(uuid)

System identifier of the user or service that last updated this company record

Example: "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f"
deletedAtstring(date-time)

Timestamp when the company was soft-deleted from the system

Example: "2024-12-01T09:00:00Z"
deletedBystring(uuid)

System identifier of the user or service that deleted this company record

Example: "d4e5f6a7-8b9c-6d7e-0f1a-2b3c4d5e6f7a"
Response
application/json
{
  "id": "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f",
  "status": "VERIFIED",
  "name": "TechFlow Solutions Ltd",
  "companyNumber": "09876543",
  "address": {
    "addressLine1": "Floor 3, 45 Commercial Road",
    "addressLine2": "Innovation Quarter",
    "addressLine3": "Shoreditch",
    "postCode": "E1 6BH",
    "city": "London",
    "countryCode": "GB"
  },
  "friendlyId": "A3F2E1D05C",
  "createdAt": "2024-03-15T10:30:00Z",
  "createdBy": "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e",
  "updatedAt": "2024-09-20T14:22:15Z",
  "updatedBy": "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f",
  "deletedAt": "2024-12-01T09:00:00Z",
  "deletedBy": "d4e5f6a7-8b9c-6d7e-0f1a-2b3c4d5e6f7a"
}

Update company information

Request

Updates company details such as name and address. This endpoint is typically used when company information changes in the payroll system.

Security
partnerAdminAuth
Path
companyIdstring(uuid)required

The unique identifier for the company

Headers
X-Aslan-Timestampinteger(int64)required

Unix epoch timestamp of the request in seconds.

Example: 1730000000
Bodyapplication/jsonrequired
Any of:
namestring[ 1 .. 200 ] charactersrequired

Updated legal name of the company

Example: "TechFlow Solutions Limited"
companyNumberstring[ 1 .. 20 ] characters

Updated official company registration number (e.g., Companies House number in the UK)

Example: "09876543"
addressobject(AddressPayload)
curl -i -X PUT \
  'https://developer.aslan.io/_mock/openapi/companies/{companyId}' \
  -H 'Authorization: Bearer <YOUR_token:signature_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Aslan-Timestamp: 1730000000' \
  -d '{
    "name": "TechFlow Solutions Limited",
    "companyNumber": "09876543",
    "address": {
      "addressLine1": "Floor 3, 45 Commercial Road",
      "addressLine2": "Innovation Quarter",
      "addressLine3": "Shoreditch",
      "postCode": "E1 6BH",
      "city": "London",
      "countryCode": "GB"
    }
  }'

Responses

Company successfully updated

Bodyapplication/json
idstring(uuid)required

Unique system identifier for the company

Example: "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f"
statusstring(CompanyStatus)required

Current registration status of the company with Aslan:

  • VERIFIED - Company is verified and active on the platform
  • DELETED - Company has been removed from the platform (soft delete)
Enum"VERIFIED""DELETED"
Example: "VERIFIED"
namestringrequired

Registered legal name of the company

Example: "TechFlow Solutions Ltd"
companyNumberstringrequired

Official company registration number (e.g., Companies House number in the UK)

Example: "09876543"
addressobject(AddressPayload)
friendlyIdstring<= 10 charactersrequired

Human-readable alphanumeric identifier for the company (max 10 characters)

Example: "A3F2E1D05C"
createdAtstring(date-time)required

Timestamp when the company was initially registered in the system

Example: "2024-03-15T10:30:00Z"
createdBystring(uuid)required

System identifier of the user or service that created this company record

Example: "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e"
updatedAtstring(date-time)

Timestamp of the most recent update to the company record

Example: "2024-09-20T14:22:15Z"
updatedBystring(uuid)

System identifier of the user or service that last updated this company record

Example: "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f"
deletedAtstring(date-time)

Timestamp when the company was soft-deleted from the system

Example: "2024-12-01T09:00:00Z"
deletedBystring(uuid)

System identifier of the user or service that deleted this company record

Example: "d4e5f6a7-8b9c-6d7e-0f1a-2b3c4d5e6f7a"
Response
application/json
{
  "id": "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f",
  "status": "VERIFIED",
  "name": "TechFlow Solutions Ltd",
  "companyNumber": "09876543",
  "address": {
    "addressLine1": "Floor 3, 45 Commercial Road",
    "addressLine2": "Innovation Quarter",
    "addressLine3": "Shoreditch",
    "postCode": "E1 6BH",
    "city": "London",
    "countryCode": "GB"
  },
  "friendlyId": "A3F2E1D05C",
  "createdAt": "2024-03-15T10:30:00Z",
  "createdBy": "b2c3d4e5-6f7a-4b5c-8d9e-0f1a2b3c4d5e",
  "updatedAt": "2024-09-20T14:22:15Z",
  "updatedBy": "c3d4e5f6-7a8b-5c6d-9e0f-1a2b3c4d5e6f",
  "deletedAt": "2024-12-01T09:00:00Z",
  "deletedBy": "d4e5f6a7-8b9c-6d7e-0f1a-2b3c4d5e6f7a"
}

Users

Manage employee records and their eligibility for earned wage access

Operations

Reports

Access spend reports and transaction data for payroll deductions

Operations