Skip to main content

Company status


Retrieve the current status of a company and its Peppol registrations.

Endpoint

PropertyValue
URLGET /white-label-partner/companies/{companyId}/status
MethodGET
AuthR-Auth: <partner-jwt>

Example Request

curl --location '{{baseUrl}}/white-label-partner/companies/{{companyId}}/status' \
--header 'R-Auth: {{partnerJwt}}'

Path parameters

ParameterTypeRequiredDescription
companyIdUUIDYesCompany UUID

Response

{
"companyId": "f5e6d7c8-1234-5678-9abc-def012345678",
"companyStatus": "ACTIVE",
"peppolStatus": "ACTIVE",
"participants": [
{
"icd": "0002",
"identifier": "426919851",
"fullParticipantIdentifier": "iso6523-actorid-upis::0002:426919851",
"peppolStatus": "ACTIVE"
}
]
}

Response fields

FieldDescription
companyStatusOverall company status
peppolStatusOverall Peppol status
participants[].icdICD scheme code
participants[].identifierBusiness identifier value
participants[].fullParticipantIdentifierFull Peppol network identifier
participants[].peppolStatusRegistration status for this participant

Participant status values

IN_PROCESS
IN_REVIEW
APPROVED
ACTIVE
REJECTED
CANCELED_BY_USER
DELETED_BY_USER
DELETED_BY_ADMIN
DELETE_REQUEST
OUTBOUND_MIGRATED