AuthorizationFlow

Retrieve the collection of AuthorizationFlow resources.

Retrieve the collection of AuthorizationFlow resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

Responses
200

AuthorizationFlow collection

400

Bad Request

401

Unauthorized

404

Resource not Found

get/authorization-flows
Request samples 
Response samples 
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}
Retrieve a AuthorizationFlow resource.
Retrieve a AuthorizationFlow resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Responses 
200
AuthorizationFlow resource


404
Resource not found


get/authorization-flows/{uuid}
Request samples 
Response samples 
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "uuid": "string",
  • "status": 0,
  • "legalEntityUUID": "string",
  • "legalEntityName": "string",
  • "legalEntityNip": "string",
  • "createdAt": "string"
}
Download XML file for signature procedure.
Download XML file for signature procedure.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Authorization Flow UUID


 
hash
required
string
Special Hash


 
Responses 
204
AuthorizationFlow resource


404
Resource not found


get/authorization-flows/{uuid}/onboard/signature-file/{hash}
Request samples 
Response samples 
null
Create a KSeFToken resource.
Create a KSeFToken resource.


SecurityBearer 
Request 
path Parameters
legalEntity
required
string
Legal Entity UUID


 
Request Body schema: 
optional
The new KSeF Token resource


authorizationToken
string  = 64 characters 
KSeF authorization token.


 
autoSelect
boolean
KSeF authorization token.


 
Responses 
201
KSeFToken resource created


400
Invalid input


422
Unprocessable entity


post/legal-entities/{legalEntity}/ksef-token/create
Request samples 
{
  • "authorizationToken": "UCTJO3VK6VYNC2YS968RE3NAO9KQ39JW71PMOM5G98BVUVZ5DCVFWXU4NHEFOGHS",
  • "autoSelect": false
}
Response samples 
{
  • "uuid": "0000x0x0-00x0-0000-xx00-0x0x0xx0000",
  • "authorizationToken": "UCTJO3VK6VYNC2YS968RE3NAO9KQ39JW71PMOM5G98BVUVZ5DCVFWXU4NHEFOGHS",
  • "isActive": true,
  • "isSelected": true
}
Remove the KSeFToken resource.
Remove the KSeFToken resource.


SecurityBearer 
Request 
path Parameters
legalEntity
required
string
Legal Entity UUID


 
Request Body schema: 
optional
Remove the KSeFToken resource.


uuid
string
KSeF token uuid.


 
Responses 
200
AuthorizationFlow resource deleted


400
Bad Request


401
Unauthorized


404
Resource not Found


delete/legal-entities/{legalEntity}/ksef-token/remove
Request samples 
{
  • "uuid": "0000x0x0-00x0-0000-xx00-0x0x0xx0000"
}
Select a KSeFToken resource.
Select a KSeFToken resource.


SecurityBearer 
Request 
path Parameters
legalEntity
required
string
Legal Entity UUID


 
Request Body schema: 
optional
Select a KSeF Token resource


uuid
string
KSeF token uuid.


 
Responses 
200
KSeFToken resource activated


400
Invalid input


422
Unprocessable entity


post/legal-entities/{legalEntity}/ksef-token/select
Request samples 
{
  • "uuid": "0000x0x0-00x0-0000-xx00-0x0x0xx0000"
}
Response samples 
{
  • "uuid": "0000x0x0-00x0-0000-xx00-0x0x0xx0000",
  • "authorizationToken": "UCTJO3VK6VYNC2YS968RE3NAO9KQ39JW71PMOM5G98BVUVZ5DCVFWXU4NHEFOGHS",
  • "isActive": true,
  • "isSelected": true
}
Create a session init resource.
Create a session init resource.


SecurityBearer 
Request 
path Parameters
legalEntity
required
string
Legal Entity UUID


 
Request Body schema: application/json
required
The new AuthorizationFlow resource


any
 
Responses 
201
Session init resource created


400
Invalid input


422
Unprocessable entity


post/legal-entities/{legalEntity}/session
Request samples 
application/json
null
Response samples 
{
  • "uuid": "0000x0x0-00x0-0000-xx00-0x0x0xx0000x",
  • "referenceNumber": "20000101-XX-XXXXXXXXXX-XXXXXXXXXX-XX",
  • "sessionStatus": "ACTIVE",
  • "createdAt": "2000-01-01T00:00:00+00:00"
}
Activates account for the Legal Entity and create authorization token.
Activates account for the Legal Entity and create authorization token.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Legal Entity UUID


 
hash
required
string
Special Hash


 
Request Body schema: multipart/form-data
optional
file
string <binary> 
 
Responses 
201
AuthorizationFlow resource created


400
Invalid input


422
Unprocessable entity


post/legal-entities/{uuid}/onboard/activate/{hash}
Request samples 
Response samples 
application/json
{
  • "ksefAuthorizationToken": "string",
  • "generateReferenceNumber": "string",
  • "generateElementReferenceNumber": "string",
  • "grantElementReferenceNumber": "string",
  • "message": "string"
}
Initialize Authorization Flow for the Company
As an operator, you can trigger flow to GET your customer onboard and authorize their account. You will receive special URL that should be provided to the customer for futher steps.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Legal Entity UUID


 
Request Body schema: application/json
optional
object
 
Responses 
201
AuthorizationFlow resource created


400
Invalid input


422
Unprocessable entity


post/legal-entities/{uuid}/onboard/init
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "authFlowUuid": "string",
  • "url": "string",
  • "message": "string"
}
Start Authorization Flow for the Legal Entity.
This will start onboarding procedure for your customer


SecurityBearer 
Request 
path Parameters
uuid
required
string
Legal Entity UUID


 
hash
required
string
Special Hash


 
Request Body schema: application/json
optional
object
 
Responses 
201
AuthorizationFlow resource created


400
Invalid input


422
Unprocessable entity


post/legal-entities/{uuid}/onboard/start/{hash}
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "authFlowUuid": "string",
  • "time": "string",
  • "message": "string"
}
Onboarding data for the Legal Entity.
Onboarding have parameters to use for full onboard flow.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Legal Entity UUID


 
hash
required
string
Special Hash


 
query Parameters
page
integer
 Default:  1
The collection page number


 
Responses 
200
AuthorizationFlow collection


400
Bad Request


401
Unauthorized


404
Resource not Found


get/onboarding/{uuid}/{hash}
Request samples 
Response samples 
application/json
[
  • {
    }
]