Create a new connection invitation

POST {{cloudagent}}/v2/connections/create-invitation?auto_accept=true

Request Params

KeyDatatypeRequiredDescription
aliasstringAlias
auto_acceptbooleanAuto-accept connection (default as per configuration)
multi_usebooleanCreate invitation for multiple use (default false)
publicbooleanCreate invitation from public DID (default false)

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"connection_id":"ffb628bf-dfb2-4c92-a6ab-65763a28c851","invitation":{"@type":"did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/connections/1.0/invitation","@id":"95b12e43-6221-4343-8c31-9beb8da99af6","imageUrl":"https://staging-api.igrant.io/v1/organizations/603e683c69dd720001c74f93/image/60b35f8ce6f8b80001e68ab2/web","recipientKeys":["2dTHzhimyAcsmPTHjYjbWMJ8q7vNKBGeVuC3WcutZPy8"],"serviceEndpoint":"https://cloudagent.igrant.io/v1/603e683c69dd720001c74f93/agent/","label":"The Retail Company (Germany)"},"invitation_url":"https://cloudagent.igrant.io/v1/603e683c69dd720001c74f93/agent/?c_i=eyJAdHlwZSI6ICJkaWQ6c292OkJ6Q2JzTlloTXJqSGlxWkRUVUFTSGc7c3BlYy9jb25uZWN0aW9ucy8xLjAvaW52aXRhdGlvbiIsICJAaWQiOiAiOTViMTJlNDMtNjIyMS00MzQzLThjMzEtOWJlYjhkYTk5YWY2IiwgImltYWdlVXJsIjogImh0dHBzOi8vc3RhZ2luZy1hcGkuaWdyYW50LmlvL3YxL29yZ2FuaXphdGlvbnMvNjAzZTY4M2M2OWRkNzIwMDAxYzc0ZjkzL2ltYWdlLzYwYjM1ZjhjZTZmOGI4MDAwMWU2OGFiMi93ZWIiLCAicmVjaXBpZW50S2V5cyI6IFsiMmRUSHpoaW15QWNzbVBUSGpZamJXTUo4cTd2TktCR2VWdUMzV2N1dFpQeTgiXSwgInNlcnZpY2VFbmRwb2ludCI6ICJodHRwczovL2Nsb3VkYWdlbnQuaWdyYW50LmlvL3YxLzYwM2U2ODNjNjlkZDcyMDAwMWM3NGY5My9hZ2VudC8iLCAibGFiZWwiOiAiVGhlIFJldGFpbCBDb21wYW55IChHZXJtYW55KSJ9"}