API routes (Click a route to expand it, click here to expand/collapse all)
GET/ ⎘
Provides the API-specification. Only enabled if API exposure is enabled.
Parameter Location Type Requirements Optional Default value Description
format URI-Query string
enum: [ "KateAPI", "InternalAPIMap", "OpenAPI", "Swagger" ]
 Yes "KateAPI" Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache.
openApiVersion URI-Query int
enum: [ 2, 3 ]
 Yes 2 Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation).
Response HTTP Type Description
Success 200 object The API-documentation.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
POST/bivStatus ⎘Authentication required
Get submission status from transferred XBRL from BIV (Bancaire Infrastructurele Voorziening), which is managed by SBRNexus.
Parameter Location Type Requirements Optional Default value Description
bivReference POST-body string
minLength: 10
maxLength: 64
 No Reference ID assigned by the BIV after toBIV delivery.
signMode POST-body string
enum: [ "customer", "kate" ]
 Yes "kate" 'customer': Digital signing of the XBRL is performed using the customer certificate. 'kate': The XBRL will be signed using the KATE certificate; provided it is recognized by SBRNexus as an authorized group-certificate.
debugRun POST-body bool Yes false If true, no actual request to the BIV is sent, but the SOAP message is output as result (request is terminated prematurely). Note that this return XML instead of JSON.
Response HTTP Type Description
Success 200 array Array of BIV statuses.
CertificateNotFoundException 500 No PKIO-certificate found at specified location.
CertificateExpiredException 500 PKIO-certificate has expired.
CertificateRejectedException 500 The PKIO-certificate was rejected.
InvalidCertificatePasswordException 200 PKIO-certificate found, but it could not be decoded with the password provided by Customer settings.
InvalidXBRLException 200 Provided XBRL is invalid and rejected. See details which stakeholder invalidated the XBRL, and why.
BIVCertificateNotFoundException 500 The public BIV-certificate could not be found. Note that this is something different than the customer PKIO-certificate.
BIVCertificateInvalidException 500 The public BIV-certificate is invalid. Note that this is something different than the customer PKIO-certificate.
ConfigurationException 500 Invalid microservice configuration. See details for details.
InvalidIdentityException 200 This providing or receiving party identity is invalid and/or not supported. See details for details.
BIVException 200 The BIV responded with a faultCode. See details for details.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('xbrl:*' OR 'xbrl:all') ⎘
POST/toBIV ⎘Authentication required
Transfer XBRL to BIV (Bancaire Infrastructurele Voorziening), which is managed by SBRNexus.
Parameter Location Type Requirements Optional Default value Description
idValuation POST-body string
minLength: 10
maxLength: 64
 No ID of the valuation.
xbrlString POST-body string
minLength: 50
maxLength: 6291456
 No String containing the XBRL-file contents. It can be retrieved using the XBRL-Mapper service.
signMode POST-body string
enum: [ "customer", "kate" ]
 Yes "kate" 'customer': Digital signing of the XBRL is performed using the customer certificate. 'kate': The XBRL will be signed using the KATE certificate; provided it is recognized by SBRNexus as an authorized group-certificate.
xades1 POST-body string
minLength: 50
maxLength: 4194304
 Yes "" XML Advanced Electronic Signature (XML Digital Signature) of first valuer.
xades2 POST-body string
minLength: 50
maxLength: 4194304
 Yes "" XML Advanced Electronic Signature (XML Digital Signature) of second valuer or plausibility reviewer.
debugRun POST-body bool Yes false If true, no actual request to the BIV is sent, but the SOAP message is output as result (request is terminated prematurely). Note that this return XML instead of JSON.
Response HTTP Type Description
Success 200 array Object with the following keys: tsFinalStatus, bivStatus (=400), bivDescription, bivReference, kateReference (=idValuation)
CertificateNotFoundException 500 No PKIO-certificate found at specified location.
CertificateExpiredException 500 PKIO-certificate has expired.
CertificateRejectedException 500 The PKIO-certificate was rejected.
InvalidCertificatePasswordException 200 PKIO-certificate found, but it could not be decoded with the password provided by Customer settings.
InvalidXBRLException 200 Provided XBRL is invalid and rejected. See details which stakeholder invalidated the XBRL, and why.
BIVCertificateNotFoundException 500 The public BIV-certificate could not be found. Note that this is something different than the customer PKIO-certificate.
BIVCertificateInvalidException 500 The public BIV-certificate is invalid. Note that this is something different than the customer PKIO-certificate.
ConfigurationException 500 Invalid microservice configuration. See details for details.
InvalidIdentityException 200 This providing or receiving party identity is invalid and/or not supported. See details for details.
DigitalSignatureException 500 Something related to the Digital Signatures is wrong; see details for details.
BIVException 200 The BIV responded with a faultCode. See details for details.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('xbrl:*' OR 'xbrl:all') ⎘
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error