LegalEntity

Retrieves the collection of LegalEntity resources.

Retrieves the collection of LegalEntity resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

Responses
200

LegalEntity collection

400
401
404
get/legal-entities
Request samples
Response samples
application/json
[
  • {
    }
]

Creates a LegalEntity resource.

Creates a LegalEntity resource.

SecurityBearer
Request
Request Body schema: application/json

The new LegalEntity resource

name
required
string

Name used to register the End User in the business registry of the jurisdiction where it is legally based.

nip
required
string

Legal entity NIP.

email
required
string <email>

Legal entity email.

url
string or null

Legal entity url.

addressLine1
required
string

Legal entity address line 1.

addressLine2
required
string

Legal entity address line 2.

postcode
required
string

Legal entity postcode.

province
string or null

Legal entity province.

city
required
string

Legal entity city.

countryIso2
required
string = 2 characters

Country code ISO 3166-1 alpha-2 codes.

Responses
201

LegalEntity resource created

400

Invalid input

422

Unprocessable entity

post/legal-entities
Request samples
application/json
{
  • "name": "Company name",
  • "nip": "0000000000",
  • "email": "user@example.com",
  • "url": "company.url",
  • "addressLine1": "ul. Street",
  • "addressLine2": "10/1",
  • "postcode": "00-000",
  • "province": "Province",
  • "city": "City",
  • "countryIso2": "PL"
}
Response samples
application/json
{
  • "uuid": "string",
  • "status": 0,
  • "_statusName": "string",
  • "name": "string",
  • "nip": "string",
  • "email": "string",
  • "url": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "postcode": "string",
  • "province": "string",
  • "city": "string",
  • "countryIso2": "string",
  • "incomingInvoiceEnabled": true,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "authFlowUUID": "string",
  • "authFlowStatus": 0,
  • "authFlowIsValid": true,
  • "authFlowUrl": "string",
  • "authFlowDeadline": "string",
  • "authFlowCreatedAt": "string",
  • "authFlowUpdatedAt": "string",
  • "customer": {
    }
}

Retrieves a LegalEntity resource.

Retrieves a LegalEntity resource.

SecurityBearer
Request
path Parameters
uuid
required
string

Resource identifier

Responses
200

LegalEntity resource

404

Resource not found

get/legal-entities/{uuid}
Request samples
Response samples
application/json
{
  • "uuid": "string",
  • "status": 0,
  • "_statusName": "string",
  • "name": "string",
  • "nip": "string",
  • "email": "string",
  • "url": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "postcode": "string",
  • "province": "string",
  • "city": "string",
  • "countryIso2": "string",
  • "incomingInvoiceEnabled": true,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "authFlowUUID": "string",
  • "authFlowStatus": 0,
  • "authFlowIsValid": true,
  • "authFlowUrl": "string",
  • "authFlowDeadline": "string",
  • "authFlowCreatedAt": "string",
  • "authFlowUpdatedAt": "string",
  • "customer": {
    }
}

Replaces the LegalEntity resource.

Replaces the LegalEntity resource.

SecurityBearer
Request
path Parameters
uuid
required
string

Resource identifier

Request Body schema: application/json

The updated LegalEntity resource

name
required
string

Name used to register the End User in the business registry of the jurisdiction where it is legally based.

nip
required
string

Legal entity NIP.

email
required
string <email>

Legal entity email.

url
string or null

Legal entity url.

addressLine1
required
string

Legal entity address line 1.

addressLine2
required
string

Legal entity address line 2.

postcode
required
string

Legal entity postcode.

province
string or null

Legal entity province.

city
required
string

Legal entity city.

countryIso2
required
string = 2 characters

Country code ISO 3166-1 alpha-2 codes.

Responses
200

LegalEntity resource updated

400

Invalid input

404

Resource not found

422

Unprocessable entity

put/legal-entities/{uuid}
Request samples
application/json
{
  • "name": "Company name",
  • "nip": "0000000000",
  • "email": "user@example.com",
  • "url": "company.url",
  • "addressLine1": "ul. Street",
  • "addressLine2": "10/1",
  • "postcode": "00-000",
  • "province": "Province",
  • "city": "City",
  • "countryIso2": "PL"
}
Response samples
application/json
{
  • "uuid": "string",
  • "status": 0,
  • "_statusName": "string",
  • "name": "string",
  • "nip": "string",
  • "email": "string",
  • "url": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "postcode": "string",
  • "province": "string",
  • "city": "string",
  • "countryIso2": "string",
  • "incomingInvoiceEnabled": true,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "authFlowUUID": "string",
  • "authFlowStatus": 0,
  • "authFlowIsValid": true,
  • "authFlowUrl": "string",
  • "authFlowDeadline": "string",
  • "authFlowCreatedAt": "string",
  • "authFlowUpdatedAt": "string",
  • "customer": {
    }
}

Validate nips.

Retrieves the collection of LegalEntity resources.

SecurityBearer
Request
Request Body schema: application/json
nips
Array of arrays
Responses
200

LegalEntity collection

get/nip/validate
Request samples
application/json
{
  • "nips": [ ]
}
Response samples
application/json
[
  • {
    }
]