niden API (v1)

Download OpenAPI specification:Download

Devices

Add device

Authorizations:

Bearer Token

Request Body schema: application/json

token

string

Responses

Request samples

Payload

Content type

application/json

{"token": "9dc3540a52ca08966a98a11fcad3b530"
}

Response samples

422

Content type

application/json

{"error": {"code": "validation_error",
"details": [{"key": "token",
"message": "Token must be filled."
}
]
}
}

Access tokens

Get access token

Request Body schema: application/json

email required	string
refresh_token	string
password required	string
grant_type required	string

Responses

Request samples

Payload

Content type

application/json

Example

Obtain access token as user

{"email": "john.doe@example.com",
"password": "password",
"grant_type": "password"
}

Response samples

200
400

Content type

application/json

Example

when new access token is obtained by user

{"access_token": "QxQHpkWVhdL_mVrmnfYrPwuK0UEKyfsrsp--q_9C71k",
"token_type": "Bearer",
"expires_in": 43200,
"refresh_token": "37YY3RZKWv-DfIhis7y3q2-B-B-5wD56uXtfihhGT5Q",
"created_at": 1782677007,
"user_id": 19
}

Revoke access token

Request Body schema: application/json

token

required

string

Responses

Request samples

Payload

Content type

application/json

{"token": "RMFTakb-8kWVknGmqAHsmvWrY_aUXpBc4N2-GdHOC6I"
}

General Files

Retrieves a list of general files

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

[{"id": 3,
"name": "shared/2025_03.pdf",
"created_at": "2026-06-28T20:03:27.389329Z",
"file_url": "https://bucket.s3.region.amazonaws.com/shared/2025_03.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260628%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260628T200327Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=ecfb126ddb4d088454ce77617407cdc312d297a7a3662b314daab07db8b3fc74"
},
{"id": 2,
"name": "shared/2025_02.pdf",
"created_at": "2026-06-28T20:03:27.388087Z",
"file_url": "https://bucket.s3.region.amazonaws.com/shared/2025_02.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260628%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260628T200327Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=c49c1c39fb4575ec47c7915cc218bcf0771eacda316d685e988383c6c5586566"
},
{"id": 1,
"name": "shared/2025_01.pdf",
"created_at": "2026-06-28T20:03:27.386010Z",
"file_url": "https://bucket.s3.region.amazonaws.com/shared/2025_01.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260628%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260628T200327Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=a8d64a057714daebe5e50b5eab10edab48ea594f912d3b8cb9101920485182ab"
}
]

Loyalty Programs

List Loyalty Programs

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"name": "Toy-Labadie",
"description": "Repudiandae est omnis. Necessitatibus consequuntur earum. Enim id occaecati.",
"bonus": 64,
"currency": "ZAR",
"points_target": 53,
"requested_withdrawal": false,
"months_duration": 89,
"join_date": null,
"start_date": null,
"end_date": null,
"realization_date": null,
"failed": false,
"regulations": null,
"resigned": false,
"monthly_points": [{"month": "2026-06-23",
"points": 10
}
],
"is_withdrawal_visible": false
}
]

Join a Loyalty Program

Authorizations:

Bearer Token

Responses

Response samples

403
404
424

Content type

application/json

{"error": {"code": "validate_no_active_program",
"details": [{"key": "_base",
"message": "You already have an active loyalty program. You cannot join another program until you complete, resign from, or the current program expires."
}
]
}
}

Request a Loyalty Program bonus withdrawal

Authorizations:

Bearer Token

Request Body schema: application/json

program_id

required

integer

Responses

Request samples

Payload

Content type

application/json

{"program_id": 123
}

Response samples

404
422
424

Content type

application/json

{"error": {"code": "find_program",
"details": [{"key": "_base",
"message": "No avaiable loyalty program"
}
]
}
}

Loyality Programs

Resign a Loyality Program

Authorizations:

Bearer Token

Responses

Response samples

404
424

Content type

application/json

{"error": {"code": "validate_program_joined",
"details": [{"key": "_base",
"message": "No avaiable loyalty program"
}
]
}
}

Notifications

Get notifications

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

[{"id": 5,
"title": "Harris and Sons",
"body": "Recusandae est laborum. Voluptatum molestiae mollitia. Rerum officiis nesciunt.",
"read": true,
"loyalty_program_id": null,
"created_at": "2026-06-28T23:03:27.899+02:00",
"notification_type": "referred_user_unrealised"
},
{"id": 3,
"title": "Block, Fahey and Rolfson",
"body": "Sed repellat voluptatem. Laboriosam repellat ea. Velit ut consectetur.",
"read": false,
"loyalty_program_id": null,
"created_at": "2026-06-28T22:03:27.899+02:00",
"notification_type": "referred_user_hired"
},
{"id": 6,
"title": "Haag Inc",
"body": "Provident voluptatibus quaerat. Illo quam voluptas. Temporibus ab ipsum.",
"read": true,
"loyalty_program_id": null,
"created_at": "2026-06-28T22:03:27.899+02:00",
"notification_type": "referred_user_realised"
},
{"id": 4,
"title": "Schamberger, Carter and Ledner",
"body": "Velit tenetur hic. Repellendus eaque et. Nemo voluptates reiciendis.",
"read": false,
"loyalty_program_id": null,
"created_at": "2026-06-28T21:03:27.899+02:00",
"notification_type": "loyalty_program_realised"
}
]

Updates notification

Authorizations:

Bearer Token

Responses

Get notification

Authorizations:

Bearer Token

path Parameters

id

required

string

Responses

Response samples

200
404
422

Content type

application/json

{"id": 15,
"title": "Kiehn-Brekke",
"body": "Alias nihil minus. Natus nemo in. Beatae dolorum commodi.",
"read": false,
"loyalty_program_id": null,
"created_at": "2026-06-28T22:03:27.966+02:00",
"notification_type": "referred_user_unrealised"
}

Referred Users

Request a referral program bonus withdrawal

Authorizations:

Bearer Token

Request Body schema: application/json

referred_user_id required	integer
treshold_number required	integer Enum: 1 2

Responses

Request samples

Payload

Content type

application/json

{"referred_user_id": 123,
"treshold_number": 1
}

Response samples

403
404
422
424

Content type

application/json

{"error": {"code": "validate_achived_treshold",
"details": [{"key": "_base",
"message": "Requested threshold is not achieved yet."
}
]
}
}

User Files

Retrieves a list of user files

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

[{"id": 3,
"name": "case_23_2025_03.pdf",
"created_at": "2026-06-28T20:03:28.148942Z",
"file_url": "https://bucket.s3.region.amazonaws.com/case_23_2025_03.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260628%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260628T200328Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=79c06ca2e2985eb209524eea37747e2af69e93fa6c7cc9f5df8a561685e3aa5d"
},
{"id": 2,
"name": "case_23_2025_02.pdf",
"created_at": "2026-06-28T20:03:28.147311Z",
"file_url": "https://bucket.s3.region.amazonaws.com/case_23_2025_02.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260628%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260628T200328Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=7e4bac96a3b2241c423151b813910da117ea02fdde5da048d2a99b3d105fbb98"
},
{"id": 1,
"name": "case_23_2025_01.pdf",
"created_at": "2026-06-28T20:03:28.144330Z",
"file_url": "https://bucket.s3.region.amazonaws.com/case_23_2025_01.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260628%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260628T200328Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=2d5f750f8314e278c0e2c88fb2c21dfc3a24ff43a02630e3970719baaa0c742e"
}
]

Users

Sends user job application

Request Body schema: application/json

email required	string
first_name required	string
last_name required	string
description	string
phone_number	string
city_or_region	string
referrer_case_id	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"first_name": "string",
"last_name": "string",
"description": "string",
"phone_number": "string",
"city_or_region": "string",
"referrer_case_id": "string"
}

Response samples

404
422
424

Content type

application/json

{"error": {"code": "validate_referrer_case_id",
"details": [{"key": "_base",
"message": "Referrer not found."
}
]
}
}

Retrieves a current user certificates data

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

{"id": 73,
"employment_certificate_requested_at": null,
"employment_certificate_sent_at": null,
"income_certificate_requested_at": null,
"income_certificate_sent_at": null
}

Destroy user

Authorizations:

Bearer Token

path Parameters

id

required

string

Responses

Response samples

404
422
424

Content type

application/json

{"error": {"code": "fetch_user",
"details": [{"key": "_base",
"message": "Translation missing: en.errors.users.not_found"
}
]
}
}

Retrieves a current user details

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

{"id": 81,
"employer": null,
"place_of_work": null,
"work_address": null,
"workplace_information": null,
"employment_type": null,
"employment_period": null,
"payroll_email": null,
"unpaid_leave_days": null,
"unpaid_leave_updated_at": null,
"absence_reports_phone_number": null,
"helpdesk_phone_number": null,
"job_coordinator_name": null,
"job_coordinator_email": null,
"job_coordinator_phone_number": null,
"accommodation_coordinator_name": null,
"accommodation_coordinator_email": null,
"accommodation_coordinator_phone_number": null,
"accommodation_address": null
}

Updates user's locale

Authorizations:

Bearer Token

Request Body schema: application/json

locale

required

string

Enum: "en" "pl" "uk" "ru"

Responses

Request samples

Payload

Content type

application/json

{"locale": "en"
}

Response samples

422

Content type

application/json

{"error": {"code": "validation_error",
"details": [{"key": "locale",
"message": "Language must be filled."
}
]
}
}

Retrieves a current user

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

{"id": 89,
"first_name": null,
"last_name": null,
"email": "shan.oconnell@schoen.test",
"case_id": 36,
"device_id": null,
"onboarding_completed": true,
"referred_users": [ ]
}

Sends user employment certificate request

Authorizations:

Bearer Token

Request Body schema: application/json

period_from required	string <date> Okres od
period_to required	string <date> Okres do

Responses

Request samples

Payload

Content type

application/json

{"period_from": "2019-08-24",
"period_to": "2019-08-24"
}

Response samples

422
424

Content type

application/json

Example

validation error

{"error": {"code": "validation_error",
"details": [{"key": "period_from",
"message": "period_from must be filled."
},
{"key": "period_to",
"message": "period_to must be filled."
}
]
}
}

Sends user income certificate request

Authorizations:

Bearer Token

Request Body schema: application/json

period_from required	string <date> Okres od
period_to required	string <date> Okres do

Responses

Request samples

Payload

Content type

application/json

{"period_from": "2019-08-24",
"period_to": "2019-08-24"
}

Response samples

422
424

Content type

application/json

Example

validation error

{"error": {"code": "validation_error",
"details": [{"key": "period_from",
"message": "period_from must be filled."
},
{"key": "period_to",
"message": "period_to must be filled."
}
]
}
}

Resets user's current password

Request Body schema: application/json

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@example.com"
}

Response samples

403
422

Content type

application/json

{"error": {"code": "validate_onboarding",
"details": [{"key": "_base",
"message": "To reset your password you have to pass onboarding. Contact Niden to get your welcome e-mail."
}
]
}
}

Sets new password for user

Request Body schema: application/json

token required	string
password required	string
password_confirmation required	string

Responses

Request samples

Payload

Content type

application/json

{"token": "3zttghdxh6yzp7tv1bh1w9hy",
"password": "Password100!",
"password_confirmation": "Password100!"
}

Response samples

422

Content type

application/json

Example

when no params

{"error": {"code": "validation_error",
"details": [{"key": "token",
"message": "Token must be filled."
},
{"key": "password",
"message": "Password must be filled."
},
{"key": "password_confirmation",
"message": "Password confirmation must be filled."
}
]
}
}