API Docs Help

User

/v1/identity/users GET

GET method/v1/identity/users

Request parameters

Responses

{ "data": [ { "id": "example", "email": "example", "recipientEmail": "example", "isActive": true, "isVerified": true, "type": "customer", "tokenIssuedAt": "1971-04-26T12:26:06Z", "name": "example", "region": "de", "webhookUrl": "example", "company": { "id": "example", "name": "example", "accountRegion": "eu", "handWrittenDocs": true, "featureControl": { "id": "example", "lineItems": true, "deliveryNote": true, "detectMultiTax": true, "duplication": true, "eInvoice": true, "pagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "dnPagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "fillVendorsData": true, "fillRecipientsData": true, "divisionId": "example", "serial": { "id": "example", "prefix": "example", "numberOfDigits": 96, "sequence": 96, "isActive": true, "isLimitExceeded": true, "userId": "example", "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "roles": [ { "isDefault": true, "name": "example" } ], "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" } ], "count": 96, "total": 96, "page": 96, "pageCount": 96 }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/users/change-password POST

POST method/v1/identity/users/change-password

Request parameters

{ "newPassword": "example", "oldPassword": "example" }

Responses

{ "user": { "id": "example", "email": "example", "recipientEmail": "example", "isActive": true, "isVerified": true, "type": "customer", "tokenIssuedAt": "1971-04-26T12:26:06Z", "name": "example", "region": "de", "webhookUrl": "example", "company": { "id": "example", "name": "example", "accountRegion": "eu", "handWrittenDocs": true, "featureControl": { "id": "example", "lineItems": true, "deliveryNote": true, "detectMultiTax": true, "duplication": true, "eInvoice": true, "pagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "dnPagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "fillVendorsData": true, "fillRecipientsData": true, "divisionId": "example", "serial": { "id": "example", "prefix": "example", "numberOfDigits": 96, "sequence": 96, "isActive": true, "isLimitExceeded": true, "userId": "example", "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "roles": [ { "isDefault": true, "name": "example" } ], "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "newToken": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/users/me GET

GET method/v1/identity/users/me

Responses

{ "user": { "id": "example", "email": "example", "recipientEmail": "example", "isActive": true, "isVerified": true, "type": "customer", "tokenIssuedAt": "1971-04-26T12:26:06Z", "name": "example", "region": "de", "webhookUrl": "example", "company": { "id": "example", "name": "example", "accountRegion": "eu", "handWrittenDocs": true, "featureControl": { "id": "example", "lineItems": true, "deliveryNote": true, "detectMultiTax": true, "duplication": true, "eInvoice": true, "pagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "dnPagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "fillVendorsData": true, "fillRecipientsData": true, "divisionId": "example", "serial": { "id": "example", "prefix": "example", "numberOfDigits": 96, "sequence": 96, "isActive": true, "isLimitExceeded": true, "userId": "example", "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "roles": [ { "isDefault": true, "name": "example" } ], "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" } }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/users/serial POST

POST method/v1/identity/users/serial

Request parameters

{ "prefix": "example", "numberOfDigits": 96 }

Responses

{ "user": { "id": "example", "email": "example", "recipientEmail": "example", "isActive": true, "isVerified": true, "type": "customer", "tokenIssuedAt": "1971-04-26T12:26:06Z", "name": "example", "region": "de", "webhookUrl": "example", "company": { "id": "example", "name": "example", "accountRegion": "eu", "handWrittenDocs": true, "featureControl": { "id": "example", "lineItems": true, "deliveryNote": true, "detectMultiTax": true, "duplication": true, "eInvoice": true, "pagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "dnPagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "fillVendorsData": true, "fillRecipientsData": true, "divisionId": "example", "serial": { "id": "example", "prefix": "example", "numberOfDigits": 96, "sequence": 96, "isActive": true, "isLimitExceeded": true, "userId": "example", "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "roles": [ { "isDefault": true, "name": "example" } ], "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" } }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/users/{id} PATCH

PATCH method/v1/identity/users/{id}

Request parameters

{ "name": "example", "type": "customer", "region": "de", "company": { "name": "example" } }

Responses

{ "id": "example", "email": "example", "recipientEmail": "example", "isActive": true, "isVerified": true, "type": "customer", "tokenIssuedAt": "1971-04-26T12:26:06Z", "name": "example", "region": "de", "webhookUrl": "example", "company": { "id": "example", "name": "example", "accountRegion": "eu", "handWrittenDocs": true, "featureControl": { "id": "example", "lineItems": true, "deliveryNote": true, "detectMultiTax": true, "duplication": true, "eInvoice": true, "pagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "dnPagesProcessingCoverage": { "splitter": { "fromBegin": 96, "fromEnd": 96 }, "ocr": { "fromBegin": 96, "fromEnd": 96 }, "extractor": { "fromBegin": 96, "fromEnd": 96 } }, "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "fillVendorsData": true, "fillRecipientsData": true, "divisionId": "example", "serial": { "id": "example", "prefix": "example", "numberOfDigits": 96, "sequence": 96, "isActive": true, "isLimitExceeded": true, "userId": "example", "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }, "roles": [ { "isDefault": true, "name": "example" } ], "companyId": "example", "createdAt": "1971-04-26T12:26:06Z", "updatedAt": "1971-04-26T12:26:06Z", "deletedAt": "1971-04-26T12:26:06Z" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/users/{id}/activate PATCH

PATCH method/v1/identity/users/{id}/activate

Request parameters

{}

Responses

{}
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/users/{id}/deactivate PATCH

PATCH method/v1/identity/users/{id}/deactivate

Request parameters

{}

Responses

{}
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }
Last modified: 14 January 2025