HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Generate Encoded Arcadia Connect URL

post
https://api.arcadia.com/plug/credentials/encodedConnectUrl

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.

Body Params
string
length between 0 and 255

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.

boolean

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

Headers
string
required
Defaults to 2024-02-21

The Arcadia-Version for the request

Response

Updated 8 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago