Introduction to API usage
This API will allow the application to fetch information about a company's organizations. Access is limited to the System User used.
For developers, the raw swagger doc for the whole API product can be found in one place here
Please use only version 2 of corporate-accounts, corporate-mobile-subscriptions and corporate-agreements since version 1 of these APIs is deprecated.
organizations
GET
/organizations/v1/organizations
Get all organizations
Implementation notes
Get all organizations that are available for the current user.
Parameters
-
Authorization*
-
The authorization header containing the access token. See the oauth-v2 API for how to obtain the token. Example: "Authorization: Bearer 065d160140eea13e72cde31a7b857bbfa37390e5"
-
header
-
string
Response class (Status 200)
- orgNumberstring
- The organization number
- namestring
- The organization name
[{ "orgNumber": "914742315", "name": "TELENOR" }]
Error responses
- 400
- Bad Request:
Error code 40001 - Missing or invalid enduserId
- 401
- Unauthorized:
Error code 40101 - Invalid resource
Error code 40102 - Missing authorization header
Error code 40103 - No API product found
Error code 40104 - Not authorized to use given MSISDN
Error code 40105 - Invalid access token
Error code 40106 - Access token expired
Error code 40107 - Basic authentication not allowed for external access or not allowed for client
Error code 40108 - Invalid client id or secret for basic authentication
- 403
- Forbidden:
Error code 40301 - Invalid scope
- 404
- Not Found:
Error code 40401 - Path or method not found
Error code 4042000 - Path or method not found on back-end server
- 429
- Too Many Requests:
Error code 42901 - Rate limit quota violation
Error code 42902 - Spike arrest violation
- 500
- Internal Server Error:
Error code 50001 - Internal Server Error
Error code 50002 - Failed to validate acr
Error code 50003 - Failed to validate subscription
Error code 500100 - Internal server error
- 503
- Service Unavailable:
Error code 503200 - External server error
GET
/organizations/v1/organizations/{orgNumber}/address-cards
Get address cards for an organization
Implementation notes
An organization may have multiple addresses registered. These addresses are used for e.g sending account invoices. When creating a new account, an address card for the organization needs to be supplied.
Parameters
-
Authorization*
-
The authorization header containing the access token. See the oauth-v2 API for how to obtain the token. Example: "Authorization: Bearer 065d160140eea13e72cde31a7b857bbfa37390e5"
-
header
-
string
-
orgNumber*
-
Organization number
-
path
-
string
Response class (Status 200)
- idstring
- The address card id.
- addressAddress
- The address.
Address
- streetNamestring
- Street name
- streetAddressstring
- Street address
- entranceCodestring
- Entrance code
- postalCodestring
- Postal code
- postalPlacestring
- Postal place
[{ "id": "554466", "address": { "streetName": "Innherredsveien", "streetAddress": "1A", "entranceCode": "H0101", "postalCode": "7018", "postalPlace": "Trondheim" } }]
Error responses
- 400
- Bad Request:
Error code 40001 - Missing or invalid enduserId
Error code 400024 - Invalid organization number provided
- 401
- Unauthorized:
Error code 40101 - Invalid resource
Error code 40102 - Missing authorization header
Error code 40103 - No API product found
Error code 40104 - Not authorized to use given MSISDN
Error code 40105 - Invalid access token
Error code 40106 - Access token expired
Error code 40107 - Basic authentication not allowed for external access or not allowed for client
Error code 40108 - Invalid client id or secret for basic authentication
- 403
- Forbidden:
Error code 40301 - Invalid scope
- 404
- Not Found:
Error code 404007 - Organization not found
Error code 40401 - Path or method not found
Error code 4042000 - Path or method not found on back-end server
- 429
- Too Many Requests:
Error code 42901 - Rate limit quota violation
Error code 42902 - Spike arrest violation
- 500
- Internal Server Error:
Error code 50001 - Internal Server Error
Error code 50002 - Failed to validate acr
Error code 50003 - Failed to validate subscription
Error code 500100 - Internal server error
- 503
- Service Unavailable:
Error code 503200 - External server error