Transfer

Show transfer preparation information

get/api/v1/transfers/{id4n}/sendInfo

Request

Base URL
https://backend.id4i.de
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/id4i/apis/id4i-api/docs/api/v1/transfers/:id4n/sendInfo/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

id4nstring required

The ID4N to retrieve information about

Response

holderOrganizationIdstring

The current holder of the object

keepOwnershipboolean required

Keep the public ownership while transferring the object

openForClaimsboolean required

Allow anyone who knows (or can scan) the ID4N to claim ownership of this object

ownerOrganizationIdstring

The current publicly visible owner of the object

recipientOrganizationIdsstring[] required

Allow only these organizations to obtain this object

Example response

{
  "holderOrganizationId": "de.id4i",
  "keepOwnership": true,
  "ownerOrganizationId": "de.bluerain",
  "recipientOrganizationIds": [
    "de.acme",
    "com.porsche",
    "de.bluerain"
  ]
}

Changes

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