# Frankie Financial API API

> Frankie Financial API API on Apizie: 46 endpoints (Retrieve a business profile from any country (AUS included)., Search for a business from any country (AUS included)., Create Business Entity and Query UBO (AUS Only), Run Report(s) against a new or existing organisation entity (AUS Only)., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/finance:frankiefinancial/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:frankiefinancial`
- Category: Finance
- Status: byok
- Source: https://frankiefinancial.io
- Page: https://apizie.tech/api/finance/frankiefinancial
- OpenAPI: https://apizie.tech/api/finance/frankiefinancial/openapi.json

------ This API allows developers to integrate the Frankie Financial Compliance Utility into their applications. The API allows: - Checking name, address, date of birth against national databases - Validating…

## Endpoints

### Retrieve a business profile from any country (AUS included).
`POST https://apizie.tech/v1/finance:frankiefinancial/international-business-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| body | object | yes | JSON request body |

### Search for a business from any country (AUS included).
`POST https://apizie.tech/v1/finance:frankiefinancial/international-business-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| body | object | yes | JSON request body |

### Create Business Entity and Query UBO (AUS Only)
`POST https://apizie.tech/v1/finance:frankiefinancial/business-ownership-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| checkType | array | no | When creating a new check, we need to define the checks we wish to run. If this parameter is not supplied then the check will be based on… |
| entityCategories | array | no | A comma separated list that specifies the categories of entities associated with the target organisation that will be checked. -… |
| resultLevel | string | no | The result level allows you to specify the level of detail returned for the entity check. You can choose summary or full. |
| validation | string | no | Should a validation check be run before the ownership query. The default is specified via configuration. The validation checks to see if… |
| generateReport | string | no | The type of human readable report, if any, to generate based on the ownership query results. |
| includeHistorical | boolean | no | If set to true, historical ownership data will be requested. |
| onlyProfile | boolean | no | If set to true, a full UBO report will not be requested. |
| body | object | yes | JSON request body |

### Run Report(s) against a new or existing organisation entity (AUS Only).
`POST https://apizie.tech/v1/finance:frankiefinancial/run-business-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| reportTypes | string | yes | Define the report(s) you wish to run. You can request more than one as a comma separated list. Duplicates will be ignored. Note: These… |
| body | object | yes | JSON request body |

### Run KYC/AML Checks on Organisation and/or Associated Individuals.
`POST https://apizie.tech/v1/finance:frankiefinancial/check-organisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| checkType | array | no | When creating a new check, we need to define the checks we wish to run. If this parameter is not supplied then the check will be based on… |
| entityCategories | array | no | A comma separated list that specifies the categories of entities associated with the target organisation that will be checked. -… |
| resultLevel | string | no | The result level allows you to specify the level of detail returned for the entity check. You can choose summary or full. |
| generateReport | string | no | The type of human readable report, if any, to generate based on the ownership query results. |

### Create New Document.
`POST https://apizie.tech/v1/finance:frankiefinancial/create-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| body | object | no | JSON request body |

### Create Document and Compare to Original.
`POST https://apizie.tech/v1/finance:frankiefinancial/compare-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| body | object | yes | JSON request body |

### Create and OCR Scan Document.
`POST https://apizie.tech/v1/finance:frankiefinancial/create-scan-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| body | object | no | JSON request body |

### Create Document and Run Utility Price Comparison.
`POST https://apizie.tech/v1/finance:frankiefinancial/create-process-industry-utility-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| planLimit | integer | no | The maximum number of plans to return |
| body | object | no | JSON request body |

### Create and Verify Document.
`POST https://apizie.tech/v1/finance:frankiefinancial/verify-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| body | object | yes | JSON request body |

### Search For a Document !! EXPERIMENTAL !!
`POST https://apizie.tech/v1/finance:frankiefinancial/search-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| body | object | yes | JSON request body |

### Retrieve Document Details
`GET https://apizie.tech/v1/finance:frankiefinancial/query-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |

### Update Existing Document.
`POST https://apizie.tech/v1/finance:frankiefinancial/update-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |
| noInvalidate | boolean | no | Disable check result invalidation for this update request. |
| body | object | yes | JSON request body |

### Delete Document.
`POST https://apizie.tech/v1/finance:frankiefinancial/delete-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |

### Retrieve Document Verification Check Details.
`GET https://apizie.tech/v1/finance:frankiefinancial/query-document-checks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |

### Update Document and Compare to Original.
`POST https://apizie.tech/v1/finance:frankiefinancial/update-compare-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |
| body | object | yes | JSON request body |

### Retrieve Document and Scan Data
`GET https://apizie.tech/v1/finance:frankiefinancial/query-document-full` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |

### Update and OCR Scan Document
`POST https://apizie.tech/v1/finance:frankiefinancial/update-scan-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |
| body | object | yes | JSON request body |

### Update Document and Run Utility Price Comparison.
`POST https://apizie.tech/v1/finance:frankiefinancial/update-process-industry-utility-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |
| planLimit | integer | no | The maximum number of plans to return |
| body | object | no | JSON request body |

### Provide Explicit Consent to Switch Utility Plans.
`POST https://apizie.tech/v1/finance:frankiefinancial/update-process-industry-utility-document-consent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |
| body | object | no | JSON request body |

### Initiate Switching of Utility Plan.
`POST https://apizie.tech/v1/finance:frankiefinancial/update-process-industry-utility-document-switch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |
| body | object | no | JSON request body |

### Update and Verify Document.
`POST https://apizie.tech/v1/finance:frankiefinancial/update-verify-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| documentId | string | yes | The documentId returned previously from an earlier call to /check or /entity or /document |
| body | object | yes | JSON request body |

### Create New Entity.
`POST https://apizie.tech/v1/finance:frankiefinancial/create-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| body | object | no | JSON request body |

### Create Entity and Get IDV Token
`POST https://apizie.tech/v1/finance:frankiefinancial/create-entity-get-idvtoken` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| body | object | yes | JSON request body |

### Create Entity and Push Self-Verification Link
`POST https://apizie.tech/v1/finance:frankiefinancial/create-check-entity-push-to-mobile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| nopush | boolean | no | If set to true, then no SMS/email will be pushed. It will be up to the API caller to manage the delivery of the link. |
| body | object | yes | JSON request body |

### Create and Verify Entity
`POST https://apizie.tech/v1/finance:frankiefinancial/create-check-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| checkType | string | yes | When creating a new check, you need to define the checks you wish to run. The checkType is make up of a comma separated list of the types… |
| resultLevel | string | yes | How much detail we return. Acceptable values are: * simple - Only available with "profile" check type. Returns just an… |
| body | object | yes | JSON request body |

### Search for Entity
`POST https://apizie.tech/v1/finance:frankiefinancial/search-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| body | object | yes | JSON request body |

### Retrieve Entity Details
`GET https://apizie.tech/v1/finance:frankiefinancial/query-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |

### Update Existing Entity.
`POST https://apizie.tech/v1/finance:frankiefinancial/update-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| noInvalidate | boolean | no | Disable check result invalidation for this update request. |
| body | object | yes | JSON request body |

### Delete Entity
`POST https://apizie.tech/v1/finance:frankiefinancial/delete-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |

### Update Check Result States (Batch)
`POST https://apizie.tech/v1/finance:frankiefinancial/update-check-class-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| checkId | string | yes | The checkId returned previously from an earlier call to */verify |
| checkClass | string | yes | Specify which check Class this action will apply to (PRO, BCRO etc.). Valid values are: - "pro": Update a Process Result Object - "bcro":… |
| body | object | yes | JSON request body |

### Update Check Result State
`POST https://apizie.tech/v1/finance:frankiefinancial/update-check-class-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| checkId | string | yes | The checkId returned previously from an earlier call to */verify |
| checkClass | string | yes | Specify which check Class this action will apply to (PRO, BCRO etc.). Valid values are: - "pro": Update a Process Result Object - "bcro":… |
| checkClassId | string | yes | A PRO/BCRO ID |
| status | string | yes | Set the new status of the Check Class (PRO/BCRO). Valid values are: - "unknown" - "true_positive" - "true_positive_accept" -… |
| undo | boolean | no | Undo a prior operation. |

### Retrieve Entity Verication Check Details
`GET https://apizie.tech/v1/finance:frankiefinancial/query-entity-checks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| alldata | boolean | no | Requests that literally all data should be included in the response to a "get checks" request. This is as opposed to a filtered view where… |

### Set Entity Blacklist State.
`POST https://apizie.tech/v1/finance:frankiefinancial/blacklist-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| set | boolean | yes | Set the value of an entity flag. |
| reason | string | no | Set the reason for blacklisting. Valid values are: - "NO_REASON_SUPPLIED" - "FABRICATED_IDENTITY" - "IDENTITY_TAKEOVER" -… |
| blockedBy | string | no | Specify who is setting the entity as blacklisted. |
| attribute | string | no | Specify the blacklisted attribute. Valid values are: - "ENTIRE_PROFILE" - "FULL_NAME" - "EMAIL_ADDRESS" - "PHONE_NUMBER" - "ID_DOCUMENT" -… |
| originalId | string | no | Specify the Id of the matching blacklisted entity or single data-point. |

### Resolve Duplicate States.
`POST https://apizie.tech/v1/finance:frankiefinancial/flag-duplicate-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| otherId | string | yes | An entityId returned previously from an earlier call to /check or /entity. Used when an operation requires two entityIds |
| set | boolean | yes | Set the value of an entity flag. |

### Set Entity Ongoing AML Monitoring Status.
`POST https://apizie.tech/v1/finance:frankiefinancial/entity-monitoring` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| set | boolean | yes | Set the value of an entity flag. |

### Set Entity Watchlist State.
`POST https://apizie.tech/v1/finance:frankiefinancial/watchlist-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| set | boolean | yes | Set the value of an entity flag. |
| reason | string | no | Set the reason for watchlisting. Valid values are: - "WAS_BLACKLISTED" |
| comment | string | no | A comment describing the reason for a request. |

### Retrieve Entity Details and Document Scan Data
`GET https://apizie.tech/v1/finance:frankiefinancial/query-entity-full` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |

### Update Entity and Get IDV Token
`POST https://apizie.tech/v1/finance:frankiefinancial/update-entity-get-idvtoken` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| body | object | yes | JSON request body |

### Update Entity and Initiate IDV Process
`POST https://apizie.tech/v1/finance:frankiefinancial/update-entity-init-idvprocess` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| body | object | yes | JSON request body |

### Update Entity States
`POST https://apizie.tech/v1/finance:frankiefinancial/update-entity-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| set | string | no | The status of an entity. Valid values are: - "wait": Waiting for new details from entity. - "fail": Manually fail the onboarding process.… |
| risk | string | no | The risk override setting for an entity. This value will be used until a verify result updates a real risk factor. Valid values are: -… |
| comment | string | no | A comment describing the reason for a request. |

### Update Entity and Push Self-Verification Link
`POST https://apizie.tech/v1/finance:frankiefinancial/update-check-entity-push-to-mobile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| nopush | boolean | no | If set to true, then no SMS/email will be pushed. It will be up to the API caller to manage the delivery of the link. |
| phase | integer | no | Set the Push To Mobile phase. Currently supported values: - 2 |
| body | object | yes | JSON request body |

### Update Entity and Verify Details
`POST https://apizie.tech/v1/finance:frankiefinancial/update-check-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| X-Frankie-Background | integer | no | If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if… |
| entityId | string | yes | The entityId returned previously from an earlier call to /check or /entity |
| checkType | string | yes | When creating a new check, you need to define the checks you wish to run. The checkType is make up of a comma separated list of the types… |
| resultLevel | string | yes | How much detail we return. Acceptable values are: * simple - Only available with "profile" check type. Returns just an… |
| force | boolean | no | Force the verification to run, overriding any data aging or past check |
| noInvalidate | boolean | no | Disable check result invalidation for this update request. |
| body | object | yes | JSON request body |

### (Re)retrieve Response Result.
`GET https://apizie.tech/v1/finance:frankiefinancial/retrieve-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Frankie-CustomerID | string | yes | Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time. |
| X-Frankie-CustomerChildID | string | no | If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.… |
| requestId | string | yes | This will be the same RequestId that was sent in the 202 acceptance response. |
| payload | string | no | Specifies the type of the payload field in the retrieved response. Default is 'string'. |

### Service Status
`GET https://apizie.tech/v1/finance:frankiefinancial/status-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| askingNicely | boolean | no | If set to true, the request is being made politely. |

### Push Notification Payload
`POST https://apizie.tech/v1/finance:frankiefinancial/notify-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| requestId | string | yes | This will be the same RequestId that was sent in the 202 acceptance response. |
| body | object | no | JSON request body |

## Example
```
curl "https://apizie.tech/v1/finance:frankiefinancial/international-business-profile" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Frankie Financial API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/finance:frankiefinancial/international-business-profile with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Frankie Financial API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Frankie Financial API itself also needs your own key from frankiefinancial.io.

### Can AI agents use the Frankie Financial API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:frankiefinancial.

### What is the status of the Frankie Financial API API?
Needs your own provider key (bring your own key)