Onboarding flow

Get existing framework agreement(s)

Get existing signed and unsigned framework agreement (if any) for the given worker.

get/public/onboarding/v1/get-framework-agreement

Request

Base URL
https://api.maqqie.app
Auth
OAuth 2
Client credentials
Token URLhttps://maqqie.app/auth/realms/maqqie/protocol/openid-connect/token
TypeScript
https://skmtc.dev/maqqie/apis/maqqie-platform-public-api/docs/public/onboarding/v1/get-framework-agreement/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

workerIdstring uuid required

The unique id of the worker, as returned from the /create-worker endpoint.

Response

Successfully created the agreement

Example response

{
  "signedAgreement": {
    "documentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "unsignedAgreement": {
    "signingUrlExpirationTimestamp": "2000-01-23T04:56:07.000+00:00",
    "signingUrl": "https://openapi-generator.tech"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.