Overview
DocFox (now part of nCino) is a FICA/AML client-onboarding platform. The Automize connector covers the onboarding lifecycle — KYC applications and the entity templates they are opened against, the profiles attached to an application, the data requirements still outstanding, the evidence submitted against each one, and the documents behind that evidence.
Setting up the connection
Auth type: Bearer Token.
- Ask your DocFox administrator for an API access token. It is issued per DocFox tenant, so a token from one tenant will not read another's applications.
- In Automize, open Settings → Connectors → DocFox → Add connection and paste it into API access token. Automize sends it as an Authorization: Bearer header.
- Automize tests the connection with GET /users, so the token needs at least read access to the tenant's users.
Rate limits
DocFox does not publish a documented rate limit. Loop over the data requirements and evidence submissions of one application at a time rather than fanning out across every application at once.
Data model
A KYC application is opened against an entity template and holds the profiles — the people and companies being onboarded. Each application has data requirements: what still has to be supplied. Evidence submissions are supplied against a requirement, and documents are the files behind a submission. Document bytes are a two-step fetch — mint a token with Create Document Token, then pass it to Download Document File.
Available operations
31 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Approve Evidence Submission | General | Accept a piece of evidence. A REGULATED DECISION - route it through a person. |
| Approve KYC Application | General | Accept an application. A REGULATED DECISION - route it through a person, not a bot. |
| Archive KYC Application | General | Archive an application, with a reason |
| Create Document Token | General | Mint a short-lived token for downloading one document. Step 1 of 2. |
| Create KYC Application | General | Open a new onboarding application against an entity template |
| Download Document File | General | Fetch a document's bytes using a minted token. Step 2 of 2. |
| Get Application Status | General | Status summary for one application - what is outstanding and what has been accepted |
| Get Data Requirement | General | Retrieve one requirement |
| Get Document | General | Document METADATA. The bytes need a token - see Download Document File. |
| Get Document Token | General | Retrieve one document token |
| Get Evidence Submission | General | Retrieve one evidence submission |
| Get KYC Application | General | Retrieve one onboarding application |
| Get KYC Entity Template | General | Retrieve one entity template |
| Get Profile | General | Retrieve one profile |
| Get User | General | Retrieve one DocFox user |
| List Account Data Requirements | General | The same, for an account application rather than a KYC application |
| List Data Requirements | General | What an application still needs. The list a chase-up automation loops over. |
| List Document Tokens | General | Tokens already minted for one document |
| List Documents | General | The files behind one evidence submission |
| List Evidence Submissions | General | What has been supplied against one requirement |
| List KYC Applications | General | List onboarding applications, newest first. The entry point for every DocFox automation. |
| List KYC Entity Templates | General | The onboarding templates this tenant has - what an application can be opened against |
| List Profiles | General | The people and companies attached to one application |
| List Users | General | DocFox users in this tenant - the people an application can be transferred to |
| Reject Evidence Submission | General | Refuse a piece of evidence, with a reason. A REGULATED DECISION. |
| Replace Evidence Submission | General | Supersede a submission with a corrected one |
| Transfer KYC Application | General | Hand an application to another DocFox user |
| Unapprove KYC Application | General | Revoke an application's approval, with a reason. A REGULATED DECISION. |
| Unarchive KYC Application | General | Restore an archived application |
| Update Evidence Submission | General | Write third-party verification data back onto a submission |
| Upload Document | General | Attach a file to an evidence submission |
Operations
Approve Evidence Submission
Accept a piece of evidence. A REGULATED DECISION - route it through a person.
| Parameter | Required | Type | Description |
|---|---|---|---|
Evidence submission ID evidence_submission_id | Yes | string |
Approve KYC Application
Accept an application. A REGULATED DECISION - route it through a person, not a bot.
| Parameter | Required | Type | Description |
|---|---|---|---|
KYC application ID kyc_application_id | Yes | string | The application's DocFox id, as returned by List KYC Applications. |
Tips
- Approving, unapproving and rejecting are regulated decisions. Route them through an approval step so a person makes the call, and let the bot do the chasing and the filing around it.
Archive KYC Application
Archive an application, with a reason
| Parameter | Required | Type | Description |
|---|---|---|---|
KYC application ID kyc_application_id | Yes | string | The application's DocFox id, as returned by List KYC Applications. |
Reason reason | Yes | string | Recorded against the decision in DocFox's audit trail. |
Create Document Token
Mint a short-lived token for downloading one document. Step 1 of 2.
| Parameter | Required | Type | Description |
|---|---|---|---|
Document ID document_id | Yes | string |
Create KYC Application
Open a new onboarding application against an entity template
| Parameter | Required | Type | Description |
|---|---|---|---|
Application data | Yes | object | The JSON:API resource object; its shape follows the entity template you open against. |
Download Document File
Fetch a document's bytes using a minted token. Step 2 of 2.
| Parameter | Required | Type | Description |
|---|---|---|---|
Document token ID document_token_id | Yes | string | Minted by Create Document Token. Short-lived — mint one per download. |
Tips
- Document tokens are short-lived. Mint one with Create Document Token immediately before the download rather than reusing a token from an earlier run.
Get Application Status
Status summary for one application - what is outstanding and what has been accepted
| Parameter | Required | Type | Description |
|---|---|---|---|
KYC application ID kyc_application_id | Yes | string | The application's DocFox id, as returned by List KYC Applications. |
Get Data Requirement
Retrieve one requirement
| Parameter | Required | Type | Description |
|---|---|---|---|
Data requirement ID data_requirement_id | Yes | string | One thing the application still needs, e.g. a certified ID for a director. |
Get Document
Document METADATA. The bytes need a token - see Download Document File.
| Parameter | Required | Type | Description |
|---|---|---|---|
Document ID document_id | Yes | string |
Get Document Token
Retrieve one document token
| Parameter | Required | Type | Description |
|---|---|---|---|
Document token ID document_token_id | Yes | string | Minted by Create Document Token. Short-lived — mint one per download. |
Get Evidence Submission
Retrieve one evidence submission
| Parameter | Required | Type | Description |
|---|---|---|---|
Evidence submission ID evidence_submission_id | Yes | string |
Get KYC Application
Retrieve one onboarding application
| Parameter | Required | Type | Description |
|---|---|---|---|
KYC application ID kyc_application_id | Yes | string | The application's DocFox id, as returned by List KYC Applications. |
Get KYC Entity Template
Retrieve one entity template
| Parameter | Required | Type | Description |
|---|---|---|---|
Entity template ID kyc_entity_template_id | Yes | string |
Get Profile
Retrieve one profile
| Parameter | Required | Type | Description |
|---|---|---|---|
Profile ID profile_id | Yes | string | A person or company on the application. |
Get User
Retrieve one DocFox user
| Parameter | Required | Type | Description |
|---|---|---|---|
User ID user_id | Yes | string |
List Account Data Requirements
The same, for an account application rather than a KYC application
| Parameter | Required | Type | Description |
|---|---|---|---|
Account application ID account_application_id | Yes | string |
List Data Requirements
What an application still needs. The list a chase-up automation loops over.
| Parameter | Required | Type | Description |
|---|---|---|---|
KYC application ID kyc_application_id | Yes | string | The application's DocFox id, as returned by List KYC Applications. |
List Document Tokens
Tokens already minted for one document
| Parameter | Required | Type | Description |
|---|---|---|---|
Document ID document_id | Yes | string |
List Documents
The files behind one evidence submission
| Parameter | Required | Type | Description |
|---|---|---|---|
Evidence submission ID evidence_submission_id | Yes | string |
List Evidence Submissions
What has been supplied against one requirement
| Parameter | Required | Type | Description |
|---|---|---|---|
Data requirement ID data_requirement_id | Yes | string | One thing the application still needs, e.g. a certified ID for a director. |
List KYC Applications
List onboarding applications, newest first. The entry point for every DocFox automation.
| Parameter | Required | Type | Description |
|---|---|---|---|
Search search | No | string | Free-text match on the applicant, e.g. a company name or registration number. |
Page number page[number] | No | integer | |
Page size page[size] | No | integer |
List KYC Entity Templates
The onboarding templates this tenant has - what an application can be opened against
No input parameters.
List Profiles
The people and companies attached to one application
| Parameter | Required | Type | Description |
|---|---|---|---|
KYC application ID kyc_application_id | Yes | string | The application's DocFox id, as returned by List KYC Applications. |
List Users
DocFox users in this tenant - the people an application can be transferred to
No input parameters.
Reject Evidence Submission
Refuse a piece of evidence, with a reason. A REGULATED DECISION.
| Parameter | Required | Type | Description |
|---|---|---|---|
Evidence submission ID evidence_submission_id | Yes | string | |
Reason reason | Yes | string | Recorded against the decision in DocFox's audit trail. |
Replace Evidence Submission
Supersede a submission with a corrected one
| Parameter | Required | Type | Description |
|---|---|---|---|
Evidence submission ID evidence_submission_id | Yes | string | |
Replacement data | Yes | object |
Transfer KYC Application
Hand an application to another DocFox user
| Parameter | Required | Type | Description |
|---|---|---|---|
KYC application ID kyc_application_id | Yes | string | The application's DocFox id, as returned by List KYC Applications. |
Transfer to user ID user_id | Yes | string |
Unapprove KYC Application
Revoke an application's approval, with a reason. A REGULATED DECISION.
| Parameter | Required | Type | Description |
|---|---|---|---|
KYC application ID kyc_application_id | Yes | string | The application's DocFox id, as returned by List KYC Applications. |
Reason reason | Yes | string | Recorded against the decision in DocFox's audit trail. |
Unarchive KYC Application
Restore an archived application
| Parameter | Required | Type | Description |
|---|---|---|---|
KYC application ID kyc_application_id | Yes | string | The application's DocFox id, as returned by List KYC Applications. |
Update Evidence Submission
Write third-party verification data back onto a submission
| Parameter | Required | Type | Description |
|---|---|---|---|
Evidence submission ID evidence_submission_id | Yes | string | |
Submission data data | Yes | object | The JSON:API resource object carrying the verification result. |
Upload Document
Attach a file to an evidence submission
| Parameter | Required | Type | Description |
|---|---|---|---|
Evidence submission ID evidence_submission_id | Yes | string | |
Document data | Yes | object | The JSON:API resource object carrying the file, usually base64-encoded. |
FAQ
- Why does downloading a document take two actions?
- Get Document returns metadata only. The bytes sit behind a short-lived document token, so the flow is Create Document Token followed by Download Document File.
- Which action does a chase-up automation start from?
- List KYC Applications, then List Data Requirements per application. The requirements list is what is still outstanding, so it is the list a reminder automation loops over.
- Can a bot approve an application?
- It can call the action, but approving and unapproving an application, and approving or rejecting evidence, are regulated decisions under FICA. Put a human approval step in front of them.