Endpoints

Create Verification Url

Create a verification URL to verify orders using an embedded integration or a flow hosted by Aclid.

Provide a screen_id obtained by first calling one of the Initiate Screen endpoints. The response will include a URL that can be shared with a customer to submit additional information for an order.

<strong>Embedded Integration</strong>

The embedded flow is a drop-in module that lets you verify orders within your web page. The flow securely collects and verifies compliance information without redirecting away from your website.

  1. Confirm with the Aclid team that your website is in our allow lists.
  2. Load the Aclid client in your application.
<script src="https://verify.aclid.bio/widget.js"></script>
  1. Create a verification URL using this endpoint.
  2. Initialize the verification in whichever way is appropriate for your application.
Aclid.showEmbeddedVerification(({ verificationUrl: string, onSuccess: function })

<strong>Hosted Flow Integration</strong>

The hosted flow allows allows your team to verify orders through Aclid without spending time on development. It is hosted by Aclid but its branding and theming is fully customizable.

  1. Create a verification URL using this endpoint and optionally provide a redirect_url to redirect users back to your website after verification.
  2. Redirect from your website to the URL created in step 1.
post/v2/verification_url/

Request

  • Base URL: https://api.aclid.bio (the document declares no server; this is the origin it was published from)
  • URL: https://api.aclid.bio/v2/verification_url/
  • Auth: none declared

Request body

screen_idstring required

The screen id for which you want to create a verification.

redirect_urlstring

The URL to redirect to after verification is completed.

Response

Successful Response

urlstring required

Example response

{
  "url": "https://verify.aclid.bio/?access_token=aclid-access-1234"
}

Changes

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