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": "63f963c44fba44cd1d45779ffa249060"
}

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": "fTPRcrQDOj7-ZXh6dOOSfVkRmRs6i4yc8Qbwv48ATeo",
"token_type": "Bearer",
"expires_in": 43200,
"refresh_token": "0YKg6kQndlnXxXlGKZnGn26ghbbepb1f38xisWvAaDc",
"created_at": 1787864412,
"user_id": 23
}

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-08-27T21:00:12.414210Z",
"file_url": "https://bucket.s3.region.amazonaws.com/shared/2025_03.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260827%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260827T210012Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=66551dc5375b084d63e1109876c30e95807aad9b56372aeaa03d9442b0de6374"
},
{"id": 2,
"name": "shared/2025_02.pdf",
"created_at": "2026-08-27T21:00:12.413088Z",
"file_url": "https://bucket.s3.region.amazonaws.com/shared/2025_02.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260827%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260827T210012Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=0a83061f857eef4c64b69be457da9dc581dad2bbeff910a674cbc4533bd42b9a"
},
{"id": 1,
"name": "shared/2025_01.pdf",
"created_at": "2026-08-27T21:00:12.411422Z",
"file_url": "https://bucket.s3.region.amazonaws.com/shared/2025_01.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260827%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260827T210012Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=a62cbf4774fdde8b85e0115469f4827543cd65e80caf97d5e78470c6d6b0274b"
}
]

Loyalty Programs

List Loyalty Programs

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"name": "Orn, Hettinger and Stark",
"description": "Ut ipsa nobis. Quis quia sit. Omnis ea architecto.",
"bonus": 29,
"currency": "JPY",
"points_target": 85,
"requested_withdrawal": false,
"months_duration": 97,
"join_date": null,
"start_date": null,
"end_date": null,
"realization_date": null,
"failed": false,
"regulations": null,
"resigned": false,
"monthly_points": [{"month": "2026-08-22",
"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": "Marks, Macejkovic and Frami",
"body": "Laborum voluptatem quasi. Quos consectetur aut. Non nesciunt enim.",
"read": true,
"loyalty_program_id": null,
"created_at": "2026-08-28T00:00:13.038+02:00",
"notification_type": "referred_user_unrealised"
},
{"id": 3,
"title": "Kassulke, Quitzon and Carter",
"body": "Officiis facilis sed. Enim nostrum quia. Iure aut est.",
"read": false,
"loyalty_program_id": null,
"created_at": "2026-08-27T23:00:13.038+02:00",
"notification_type": "loyalty_program_joined"
},
{"id": 6,
"title": "Greenholt-Jaskolski",
"body": "Eligendi quo dicta. At voluptas aliquam. Sunt qui distinctio.",
"read": true,
"loyalty_program_id": null,
"created_at": "2026-08-27T23:00:13.038+02:00",
"notification_type": "loyalty_program_update"
},
{"id": 4,
"title": "Kirlin, Brekke and Schoen",
"body": "Nostrum placeat sed. Amet molestiae exercitationem. Neque unde ut.",
"read": false,
"loyalty_program_id": null,
"created_at": "2026-08-27T22:00:13.038+02:00",
"notification_type": "loyalty_program_new"
}
]

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": "Tillman-VonRueden",
"body": "Molestiae esse sit. Corporis et earum. Voluptatum dolores reprehenderit.",
"read": false,
"loyalty_program_id": null,
"created_at": "2026-08-27T23:00:13.113+02:00",
"notification_type": "loyalty_program_update"
}

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_27_2025_03.pdf",
"created_at": "2026-08-27T21:00:13.323251Z",
"file_url": "https://bucket.s3.region.amazonaws.com/case_27_2025_03.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260827%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260827T210013Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=06df657c22cb90857202096f37cd81f5f96020d7aa5e804d0f0068bf0ff46c38"
},
{"id": 2,
"name": "case_27_2025_02.pdf",
"created_at": "2026-08-27T21:00:13.321532Z",
"file_url": "https://bucket.s3.region.amazonaws.com/case_27_2025_02.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260827%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260827T210013Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=80736ea62893793a1fbcfb1224b9d3281cb3bd633ced926f11cf2fbaf7763c49"
},
{"id": 1,
"name": "case_27_2025_01.pdf",
"created_at": "2026-08-27T21:00:13.318472Z",
"file_url": "https://bucket.s3.region.amazonaws.com/case_27_2025_01.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id%2F20260827%2Fregion%2Fs3%2Faws4_request&X-Amz-Date=20260827T210013Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=5d434eeb3cf3327ad65812b84b9ed970ba1d341cc955c268ae18927fb6267767"
}
]

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": 77,
"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": 85,
"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": 93,
"first_name": null,
"last_name": null,
"email": "gaston_deckow@kihn.test",
"case_id": 40,
"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."
}
]
}
}