FAQ

Collection Requests

1. How do I get the childAccountId?

> Go to Child Account → Settings → API Keys and copy the Org ID. Use this value as childAccountId when creating a Collection Request. See Create Request.

2. Where do I get the templateId?

> Go to Business Dashboard → Forms, locate the relevant form, and scroll to the bottom to find its ID. Use this value as templateId when creating a Collection Request.

3. How do I get the Collection Request ID?

> Create a Collection Request and read _id from the response. Use this ID to read the request and form the complete guest check-in URL. See Create Request and Read Request.

4. What URL should I send to participants?

> Send each guest the complete check-in URL for their travelling party's Collection Request. Do not send the Collection Request ID by itself. Members of the same travelling party use the same Collection Request, while separate travelling parties should have separate requests.

See Create Request for the production and staging guest URL formats.

5. Can someone outside participantList join?

> Yes, but an admin participant must give them the join link provided by qid during check-in. Without that link, an unlisted guest cannot join. Additional guests may join only while the total number of participants does not exceed maximumParticipants.

Shares and Participant Data

1. Where do I get the Share ID?

> After the Share has been created, call Read Request with the Collection Request ID and read shareId from the response. Webhook payloads do not contain the Share ID. See Read Request.

2. Where can I get participant data?

> Call Read Share using the shareId. Basic participant details are available under participants[].accountSnapshot, and shared document IDs are available under participants[].sharedDocumentsIds. See Read Share.

3. How do I know whether an individual or the whole group completed check-in?

> For an individual participant, check participants[].participantShareStatus. A value of completed means that participant completed check-in.

For the whole group, check the Share's top-level status. The group is complete when this value is completed. The webhook reports the overall state as shareStatus.

4. What does an open Share mean?

> An open Share means at least one participant in the travelling party has not completed check-in. It remains open until every participant associated with that Collection Request has completed. It then changes automatically to completed.

minimumParticipants and maximumParticipants control the allowed group size; they are not completion thresholds.

5. Why is participantShareStatus missing?

> The participantShareStatus field is added only after that participant completes check-in. If the field is absent, the participant has not completed check-in yet. Use the Share's top-level status to check the overall group state.

6. How do I read a document shared by a participant?

> 1. Call Read Share using the shareId.

2. Find the participant in participants.
3. Get the required document ID from sharedDocumentsIds.
4. Pass it as document_id to Read Document.

See Read Share and Read Document.

Documents

1. How do I create a document?

> 1. Send the document image to ScanXtract.

2. Use the ScanXtract result as the body of Create Document.
3. Provide the document owner and document metadata as query parameters.

ScanXtract is required before creating a document. See ScanXtract and Create Document.

2. Where do I get the document ID?

> The main source for a participant's shared document IDs is participants[].sharedDocumentsIds in the Read Share response. To look up a user's documents directly, call List User Documents and read data[].document_id.

See Read Share and List User Documents.

Webhooks

1. Why am I not receiving webhooks?

> Check the following in order:

Confirm that both webhookUrl and webhookSecret were provided when creating the Collection Request. Both are mandatory for webhook delivery; both may be left blank when webhooks are not needed.

Confirm that the webhook URL is reachable and accepts JSON POST requests.

Confirm that the Share's state has changed since the Collection Request was created.

Ensure the endpoint does not redirect, because webhook redirects are not followed.

Ensure the endpoint responds within five seconds.

Check firewall, proxy, server, and application logs for rejected requests.

Confirm that signature verification is not rejecting a valid delivery.

See Webhook for delivery and signature details.

2. When are webhooks sent?

> A webhook is sent when the Share's state changes. A Collection Request may therefore produce multiple webhook deliveries. Treat each webhook as a notification and use its requestId to fetch the latest state through the API.

3. Does the webhook contain participant data?

> No. Read requestId from the webhook, call Read Request to obtain shareId, and then call Read Share to retrieve participant details and shared document IDs.

See Read Request and Read Share.

4. The webhook has no shareId. How do I get it?

> 1. Read requestId from the webhook.

2. Call Read Request using that ID.
3. Read shareId from the response.
4. Use shareId to call Read Share.

The webhook does not include shareId. See Read Request.

5. How do I match a webhook to my booking or reference?

> Pass your booking ID or internal reference as webhookIdentifier when creating the Collection Request. The same value is included in webhook payloads so you can associate each notification with your own record.