API Docs Help

Auth

/v1/identity/auth/check-email GET

GET method/v1/identity/auth/check-email

Request parameters

Responses

{ "userExist": true, "domainReachedLimit": true, "isFreeEmail": true, "email": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/auth/forget-password POST

POST method/v1/identity/auth/forget-password

Request parameters

{ "email": "example" }

Responses

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

/v1/identity/auth/send-verification-email POST

POST method/v1/identity/auth/send-verification-email

Request parameters

{ "email": "example" }

Responses

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

/v1/identity/auth/set-password PATCH

PATCH method/v1/identity/auth/set-password

Request parameters

{ "token": "example", "password": "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" }, "token": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/auth/signin POST

POST method/v1/identity/auth/signin

Request parameters

{ "email": "example", "password": "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" }, "token": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/auth/signup POST

POST method/v1/identity/auth/signup

Request parameters

{ "email": "example", "name": "example", "password": "example", "companyName": "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" }, "token": "example", "jwt": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/identity/auth/verify PATCH

PATCH method/v1/identity/auth/verify

Request parameters

{ "token": "example" }

Responses

{ "result": true }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }
Last modified: 20 October 2024
IdentityApiKey