API Reference

Creates framework agreement.

post
https://data-sharing.api.eu1.scalar.zf.com/v1/framework-agreements

Creates framework agreement.

📘

The rate limit for this API is small.

Body Params
string | null

Agreement name.

string | null

Agreement description.

string
enum
Allowed:
string
enum
Allowed:
string
enum
Allowed:
uuid | null

Consumer's organization ID.

string | null

Consumer's organization name.

string
enum
Allowed:
boolean

Represents a flag for existing customer.

string
enum
Allowed:
string | null

Consumer's primary email address.

string | null

Consumer's primary last name.

string | null

Consumer's primary first name.

boolean

Represents a flag to allow further sharing.

string
enum
Allowed:
string
enum
Allowed:
string | null

Allowed languages: bg, cs, da, de, en, es, fi, fr, hu, it, lt, lv, nb, nl, no, pl, pt_br, ro, sk, sv, tr

boolean

Indicates if an integrator should be created.

uuid | null

Profile ID represents profile details for an organization.

valuePropositionIds
array of uuids | null

If agreement is creating with value propositions, then the value proposition ids should be passed here.

valuePropositionIds
boolean

If you want to include all value propositions, set to true. In this case, you do not need to provide individual value proposition IDs.

boolean

Framework agreement creation is allowed when there are no value propositions and when DataPrivacy is set to false for the asset truck type, meaning data will be shared with both parties.

Responses

401

Failure code. Unauthorized access.

403

Failure code. Forbidden access.

429

Failure code. Too many incoming requests.

Updated 8 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?