Request a collection review

After all required supporting documents are uploaded, you can ask Swan to review your collection using the API or on your Dashboard.

Prerequisites

The collection must have the status Waiting for document, and there must be at least one document in the collection with the status Uploaded.

You should only call this mutation if the onboarding is finalized and the account holder exists.

API guide

1. First, retrieve the collection ID (supportingDocumentCollectionId).
2. Call the requestSupportingDocumentCollectionReview mutation.
3. Enter the collection ID retrieved in step 1.
4. Add optional messages to the payload, either for validation or in case of rejection.

Mutation

🔎 Open the mutation in API Explorer

mutation RequestCollectionReview {
  requestSupportingDocumentCollectionReview(
    input: { supportingDocumentCollectionId: "$COLLECTION_ID" }
  ) {
    ... on RequestSupportingDocumentCollectionReviewSuccessPayload {
      __typename
      supportingDocumentCollection {
        id
        statusInfo {
          status
        }
      }
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on SupportingDocumentCollectionNotFoundRejection {
      id
      message
    }
    ... on SupportingDocumentCollectionStatusNotAllowedRejection {
      __typename
      message
      newStatus
      oldStatus
    }
  }
}

Payload

Notice the status PendingReview. You can also confirm this on your Dashboard—there should be an infobox in the supporting documents tab for this onboarding.

{
  "data": {
    "requestSupportingDocumentCollectionReview": {
      "__typename": "RequestSupportingDocumentCollectionReviewSuccessPayload",
      "supportingDocumentCollection": {
        "id": "b52c51b4-8a23-45a2-b77a-e6d691f4578c",
        "statusInfo": {
          "status": "PendingReview"
        }
      }
    }
  }
}

Dashboard: Onboarding

Use the Dashboard to request a review of your supporting document collection.

1. On your Dashboard, go to Data > Onboardings.
2. Open the onboarding for which you'd like to request a collection review.
3. Open the Supporting documents tab.
4. Click Request document review to begin the review process.
5. A confirmation modal will appear. Click Confirm to finalize your request.

No updates while pending review

As soon as you click Confirm, you can no longer upload additional documents or change uploaded documents until the review is complete.