v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Credentials

Generate Encoded Arcadia Connect URL

This endpoint generates a submission URL for Arcadia Connect with encoded parameters. The encoding prevents users from tampering with the generated URLs, so they may be shared with users to track which user submitted each Credential. Credentials submitted through an encoded URL will have the provided Correlation ID and will have the createdBy field set to the user who generates this link if isCreatorAttributed is set to true. A user can submit multiple Credentials through a URL, but the URL expires after 30 days. Learn more about Correlation IDs in Connect here.

post/plug/credentials/encodedConnectUrl

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

correlationIdstring

An ID used to match the utility data pulled for this request back to users in your system. Correlation ID does not have to be unique.

isCreatorAttributedboolean

If true, any credentials created with the generated URL will be attributed to the user making this request.

Response

OK

encodedUrlstring required