Skip to content
API Reference
/
/
Gets details for all vali...

Aritma Banking API (v3)

Download OpenAPI description
bankservice-openapi.json
bankservice-openapi.yaml
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/banking/v3/openapi/bankservice-openapi
Open Banking API
https://bankservice.zdata.no
Open Banking API (Dev)
https://bankservicedemo.zdata.no

Account

Operations

AccountGroup

Operations

Balance

Operations

Company

Operations

Gets details for all valid companies

Request

Subject to change. Data may be migrated to another API

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Query
stateinteger(int32)(CompanyState)

Optional state filter

Enum012999
No request payload

Responses

Flat list of valid companies

Body
Array [
parentCompanyIdstring or null(uuid)

Id of parent company. Can be used to request subsidiary status for company. NOT IMPLEMENTED FOR EXTERNAL USE!

namestring or null

Company name

addressstring or null

Company address

zipCodestring or null

Company zipcode

zipAreastring or null

Company zip area

countrystring or null

Company country

organizationNumberstringnon-emptyrequired

Company organization number. If matched in Brønnøysund, company name and adress will be overwritten

companyIdstring(uuid)required

Company id

stateinteger(int32)(CompanyState)required

CompanyState

  • 0 - Unknown
  • 1 - Active
  • 2 - Wait for zData approve
  • 999 - Deleted
Enum012999
]
Response
No response example

Create new company

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Body

Company model

organizationNumberstringnon-emptyrequired

Company organization number. If matched in Brønnøysund, company name and adress will be overwritten

companyIdstring or null(uuid)

Desired company id (optional)

parentCompanyIdstring or null(uuid)

Id of parent company. Can be used to request subsidiary status for company.

namestring or null

Company name. Mandatory for companies outside Norway

addressstring or null

Company address

zipCodestring or null

Company zipcode

zipAreastring or null

Company zip area

countrystring or null

Company country required if company is not found in The Brønnøysund Register. Mandatory for companies outside Norway

{
  "CompanyId": "3d7ee438-7ff1-4191-809c-91bad8ad31c7",
  "Name": "Duck corp",
  "Address": "Apalveien 222",
  "ZipCode": "0010",
  "ZipArea": "Oslo",
  "Country": "Norway"
}

Responses

"Company id"

Body
string(uuid)
Response
No response example

Gets company details

Request

Subject to change. Data may be migrated to another API

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company id

No request payload

Responses

Company dto

Body
parentCompanyIdstring or null(uuid)

Id of parent company. Can be used to request subsidiary status for company. NOT IMPLEMENTED FOR EXTERNAL USE!

namestring or null

Company name

addressstring or null

Company address

zipCodestring or null

Company zipcode

zipAreastring or null

Company zip area

countrystring or null

Company country

organizationNumberstringnon-emptyrequired

Company organization number. If matched in Brønnøysund, company name and adress will be overwritten

companyIdstring(uuid)required

Company id

stateinteger(int32)(CompanyState)required

CompanyState

  • 0 - Unknown
  • 1 - Active
  • 2 - Wait for zData approve
  • 999 - Deleted
Enum012999
Response
{
  "Name": "Z Data AS",
  "Address": "Damsgårdsveien 167",
  "ZipCode": "5160",
  "ZipArea": "Laksevåg",
  "Country": "Norge",
  "OrganizationNumber": "976197976",
  "CompanyId": "a5a64a21-cae3-4055-bf8f-701481d66fbc",
  "State": 1
}

Deactivate company

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company id

No request payload

Responses

"Company id"

Gets company subsidiaries

Request

Subject to change. Data may be migrated to another API

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company id

No request payload

Responses

Subsidiary dto's

Body
Array [
parentCompanyIdstring or null(uuid)

Id of parent company. Can be used to request subsidiary status for company. NOT IMPLEMENTED FOR EXTERNAL USE!

namestring or null

Company name

addressstring or null

Company address

zipCodestring or null

Company zipcode

zipAreastring or null

Company zip area

countrystring or null

Company country

organizationNumberstringnon-emptyrequired

Company organization number. If matched in Brønnøysund, company name and adress will be overwritten

companyIdstring(uuid)required

Company id

stateinteger(int32)(CompanyState)required

CompanyState

  • 0 - Unknown
  • 1 - Active
  • 2 - Wait for zData approve
  • 999 - Deleted
Enum012999
]
Response
No response example

Gets company users

Request

Subject to change. Data may be migrated to another API

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company id

No request payload

Responses

"Company id"

Body
Array [
idstringnon-emptyrequired

User id

companyIdstring(uuid)required

Company id

usernamestringnon-emptyrequired

Username

emailstringnon-emptyrequired

Users email

namestringnon-emptyrequired

Name

phoneNumberstringnon-emptyrequired

Phone number

activeUserboolean
accountingSystemUserstring or null

Username in accounting system

]
Response
No response example

EventGridDeadLetter

Operations

EventGridSubscription

Operations

Onboarding

Operations

Payment

Operations

Receivable

Operations

Recipients

Operations

Services

Operations

Statement

Operations

User

Operations