A document of an application

GET

/api/v1/onboarding/applications/{id}/documents/{kind}

const url = 'https://example.com/api/v1/onboarding/applications/example/documents/example';
const options = {
  method: 'GET',
  headers: {cookie: 'bl_authority_session=<bl_authority_session>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/onboarding/applications/example/documents/example \
  --cookie bl_authority_session=<bl_authority_session>

The PDF of the latest signing request: the signed one once available, otherwise the one to be signed. For users of the authority, and for the applicant’s connector.

Authorizations

session
dpop
bearer
dcp

Parameters

Path Parameters

required

string

The id of the application.

kind

required

string

The kind of document, e.g. the rulebook declaration or the mandate.

Responses

200

A PDF.

application/pdf

Array<integer>

401

Not authenticated.

application/json

The body of every failed call to a management API.

object

error

required

object

code

required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string

message

required

For people; may change between versions.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

404

Not found.

application/json

The body of every failed call to a management API.

object

error

required

object

code

required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string

message

required

For people; may change between versions.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}