id4i-api

name	id4i-api
description	ID4i API skill. Use when working with ID4i for account, api, go. Covers 107 endpoints.
version	1.0.0
generator	lapsh

ID4i API

API version: 1.0.2

Auth

ApiKey Authorization in header

Base URL

https://backend.id4i.de/

Setup

1. Set your API key in the appropriate header
2. GET /api/v1/apikeys -- verify access
3. POST /account/password -- create first password

Endpoints

107 endpoints across 5 groups. See references/api-spec.lap for full details.

account

Method	Path	Description
POST	/account/password	Request password reset
PUT	/account/password	Verify password reset
POST	/account/registration	Register user
PUT	/account/registration	Complete registration
POST	/account/verification	Verify registration

api

Method	Path	Description
GET	/api/v1/apikeys	Find API key by organization
POST	/api/v1/apikeys	Create API key
GET	/api/v1/apikeys/privileges	List all privileges
GET	/api/v1/apikeys/{key}	Show API key
PUT	/api/v1/apikeys/{key}	Update API keys
DELETE	/api/v1/apikeys/{key}	Delete API key
GET	/api/v1/apikeys/{key}/privileges	List privileges
POST	/api/v1/apikeys/{key}/privileges	Add privilege
DELETE	/api/v1/apikeys/{key}/privileges	Remove privilege
GET	/api/v1/apikeys/{key}/privileges/{privilege}/id4ns	ID4ns of a privilege
POST	/api/v1/apikeys/{key}/privileges/{privilege}/id4ns	Add ID4ns of a privilege
DELETE	/api/v1/apikeys/{key}/privileges/{privilege}/id4ns	Remove id4ns of a privilege
GET	/api/v1/billing/{organizationId}	Get billing amount of services for a given organization
GET	/api/v1/billing/{organizationId}/positions	Get billing positions for a given organization
GET	/api/v1/changelog/organization/{organizationId}/	List change log entries of an organization
POST	/api/v1/collections	Create collection
GET	/api/v1/collections/{id4n}	Find collection
DELETE	/api/v1/collections/{id4n}	Delete collection
PATCH	/api/v1/collections/{id4n}	Update collection
GET	/api/v1/collections/{id4n}/elements	List contents of the collection
POST	/api/v1/collections/{id4n}/elements	Add elements to collection
DELETE	/api/v1/collections/{id4n}/elements	Remove elements from collection
GET

go

Method	Path	Description
GET	/go/{guid}	Forward

login

Method	Path	Description
POST	/login	ID4i API Login

whois

Method	Path	Description
GET	/whois/{id4n}	Resolve owner of id4n

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a password?" -> POST /account/password
• "Create a registration?" -> POST /account/registration
• "Create a verification?" -> POST /account/verification
• "List all apikeys?" -> GET /api/v1/apikeys
• "Create a apikey?" -> POST /api/v1/apikeys
• "List all privileges?" -> GET /api/v1/apikeys/privileges
• "Get apikey details?" -> GET /api/v1/apikeys/{key}
• "Update a apikey?" -> PUT /api/v1/apikeys/{key}
• "Delete a apikey?" -> DELETE /api/v1/apikeys/{key}
• "List all privileges?" -> GET /api/v1/apikeys/{key}/privileges
• "Create a privilege?" -> POST /api/v1/apikeys/{key}/privileges
• "List all id4ns?" -> GET /api/v1/apikeys/{key}/privileges/{privilege}/id4ns
• "Create a id4n?" -> POST /api/v1/apikeys/{key}/privileges/{privilege}/id4ns
• "Get billing details?" -> GET /api/v1/billing/{organizationId}
• "List all positions?" -> GET /api/v1/billing/{organizationId}/positions
• "Get organization details?" -> GET /api/v1/changelog/organization/{organizationId}/
• "Create a collection?" -> POST /api/v1/collections
• "Get collection details?" -> GET /api/v1/collections/{id4n}
• "Delete a collection?" -> DELETE /api/v1/collections/{id4n}
• "Partially update a collection?" -> PATCH /api/v1/collections/{id4n}
• "List all elements?" -> GET /api/v1/collections/{id4n}/elements
• "Create a element?" -> POST /api/v1/collections/{id4n}/elements
• "List all countries?" -> GET /api/v1/countries
• "Get document details?" -> GET /api/v1/documents/{id4n}
• "Get document details?" -> GET /api/v1/documents/{id4n}/{organizationId}
• "Update a document?" -> PUT /api/v1/documents/{id4n}/{organizationId}
• "Get document details?" -> GET /api/v1/documents/{id4n}/{organizationId}/{fileName}
• "Delete a document?" -> DELETE /api/v1/documents/{id4n}/{organizationId}/{fileName}
• "List all metadata?" -> GET /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata
• "Create a guid?" -> POST /api/v1/guids
• "List all withoutCollection?" -> GET /api/v1/guids/withoutCollection
• "Get guid details?" -> GET /api/v1/guids/{id4n}
• "Partially update a guid?" -> PATCH /api/v1/guids/{id4n}
• "Get history details?" -> GET /api/v1/history/{id4n}
• "Get history details?" -> GET /api/v1/history/{id4n}/{organizationId}
• "Get history details?" -> GET /api/v1/history/{id4n}/{organizationId}/{sequenceId}
• "Partially update a history?" -> PATCH /api/v1/history/{id4n}/{organizationId}/{sequenceId}
• "Get id4n details?" -> GET /api/v1/id4ns/{id4n}

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP