{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:frankiefinancial/international-business-profile":{"post":{"operationId":"finance_frankiefinancial_international_business_profile","summary":"Retrieve a business profile from any country (AUS included).","description":"POST /business/international/profile","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/international-business-search":{"post":{"operationId":"finance_frankiefinancial_international_business_search","summary":"Search for a business from any country (AUS included).","description":"POST /business/international/search","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/business-ownership-query":{"post":{"operationId":"finance_frankiefinancial_business_ownership_query","summary":"Create Business Entity and Query UBO (AUS Only)","description":"POST /business/ownership/query","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"array","description":"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":{"type":"array","description":"A comma separated list that specifies the categories of entities associated with the target organisation that will be checked. -…"},"resultLevel":{"type":"string","enum":["summary","full"],"default":"summary","description":"The result level allows you to specify the level of detail returned for the entity check. You can choose summary or full."},"validation":{"type":"string","enum":["on","off","only","acn"],"description":"Should a validation check be run before the ownership query. The default is specified via configuration. The validation checks to see if…"},"generateReport":{"type":"string","description":"The type of human readable report, if any, to generate based on the ownership query results."},"includeHistorical":{"type":"boolean","description":"If set to true, historical ownership data will be requested."},"onlyProfile":{"type":"boolean","description":"If set to true, a full UBO report will not be requested."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/run-business-reports":{"post":{"operationId":"finance_frankiefinancial_run_business_reports","summary":"Run Report(s) against a new or existing organisation entity (AUS Only).","description":"POST /business/reports","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","reportTypes","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/check-organisation":{"post":{"operationId":"finance_frankiefinancial_check_organisation","summary":"Run KYC/AML Checks on Organisation and/or Associated Individuals.","description":"POST /business/{entityId}/verify","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"checkType":{"type":"array","description":"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":{"type":"array","description":"A comma separated list that specifies the categories of entities associated with the target organisation that will be checked. -…"},"resultLevel":{"type":"string","enum":["summary","full"],"default":"summary","description":"The result level allows you to specify the level of detail returned for the entity check. You can choose summary or full."},"generateReport":{"type":"string","description":"The type of human readable report, if any, to generate based on the ownership query results."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/create-document":{"post":{"operationId":"finance_frankiefinancial_create_document","summary":"Create New Document.","description":"POST /document","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/compare-document":{"post":{"operationId":"finance_frankiefinancial_compare_document","summary":"Create Document and Compare to Original.","description":"POST /document/new/compare","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/create-scan-document":{"post":{"operationId":"finance_frankiefinancial_create_scan_document","summary":"Create and OCR Scan Document.","description":"POST /document/new/scan","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/create-process-industry-utility-document":{"post":{"operationId":"finance_frankiefinancial_create_process_industry_utility_document","summary":"Create Document and Run Utility Price Comparison.","description":"POST /document/new/utility/process/compare","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"integer","default":30,"description":"The maximum number of plans to return"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/verify-document":{"post":{"operationId":"finance_frankiefinancial_verify_document","summary":"Create and Verify Document.","description":"POST /document/new/verify","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/search-document":{"post":{"operationId":"finance_frankiefinancial_search_document","summary":"Search For a Document !! EXPERIMENTAL !!","description":"POST /document/search","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/query-document":{"get":{"operationId":"finance_frankiefinancial_query_document","summary":"Retrieve Document Details","description":"GET /document/{documentId}","tags":["finance"],"parameters":[{"name":"X-Frankie-CustomerID","in":"query","required":true,"description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.","schema":{"type":"string","description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time."}},{"name":"X-Frankie-CustomerChildID","in":"query","required":false,"description":"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.…","schema":{"type":"string","description":"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.…"}},{"name":"documentId","in":"query","required":true,"description":"The documentId returned previously from an earlier call to /check or /entity or /document","schema":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-document":{"post":{"operationId":"finance_frankiefinancial_update_document","summary":"Update Existing Document.","description":"POST /document/{documentId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","documentId","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"},"noInvalidate":{"type":"boolean","description":"Disable check result invalidation for this update request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/delete-document":{"post":{"operationId":"finance_frankiefinancial_delete_document","summary":"Delete Document.","description":"DELETE /document/{documentId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","documentId"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/query-document-checks":{"get":{"operationId":"finance_frankiefinancial_query_document_checks","summary":"Retrieve Document Verification Check Details.","description":"GET /document/{documentId}/checks","tags":["finance"],"parameters":[{"name":"X-Frankie-CustomerID","in":"query","required":true,"description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.","schema":{"type":"string","description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time."}},{"name":"X-Frankie-CustomerChildID","in":"query","required":false,"description":"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.…","schema":{"type":"string","description":"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.…"}},{"name":"X-Frankie-Background","in":"query","required":false,"description":"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…","schema":{"type":"integer","description":"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…"}},{"name":"documentId","in":"query","required":true,"description":"The documentId returned previously from an earlier call to /check or /entity or /document","schema":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-compare-document":{"post":{"operationId":"finance_frankiefinancial_update_compare_document","summary":"Update Document and Compare to Original.","description":"POST /document/{documentId}/compare","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","documentId","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/query-document-full":{"get":{"operationId":"finance_frankiefinancial_query_document_full","summary":"Retrieve Document and Scan Data","description":"GET /document/{documentId}/full","tags":["finance"],"parameters":[{"name":"X-Frankie-CustomerID","in":"query","required":true,"description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.","schema":{"type":"string","description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time."}},{"name":"X-Frankie-CustomerChildID","in":"query","required":false,"description":"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.…","schema":{"type":"string","description":"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.…"}},{"name":"documentId","in":"query","required":true,"description":"The documentId returned previously from an earlier call to /check or /entity or /document","schema":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-scan-document":{"post":{"operationId":"finance_frankiefinancial_update_scan_document","summary":"Update and OCR Scan Document","description":"POST /document/{documentId}/scan","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","documentId","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-process-industry-utility-document":{"post":{"operationId":"finance_frankiefinancial_update_process_industry_utility_document","summary":"Update Document and Run Utility Price Comparison.","description":"POST /document/{documentId}/utility/process/compare","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","documentId"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"},"planLimit":{"type":"integer","default":30,"description":"The maximum number of plans to return"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-process-industry-utility-document-consent":{"post":{"operationId":"finance_frankiefinancial_update_process_industry_utility_document_consent","summary":"Provide Explicit Consent to Switch Utility Plans.","description":"POST /document/{documentId}/utility/process/consent","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","documentId"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-process-industry-utility-document-switch":{"post":{"operationId":"finance_frankiefinancial_update_process_industry_utility_document_switch","summary":"Initiate Switching of Utility Plan.","description":"POST /document/{documentId}/utility/process/switch","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","documentId"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-verify-document":{"post":{"operationId":"finance_frankiefinancial_update_verify_document","summary":"Update and Verify Document.","description":"POST /document/{documentId}/verify","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","documentId","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The documentId returned previously from an earlier call to /check or /entity or /document"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/create-entity":{"post":{"operationId":"finance_frankiefinancial_create_entity","summary":"Create New Entity.","description":"POST /entity","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/create-entity-get-idvtoken":{"post":{"operationId":"finance_frankiefinancial_create_entity_get_idvtoken","summary":"Create Entity and Get IDV Token","description":"POST /entity/new/idvalidate/getToken","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/create-check-entity-push-to-mobile":{"post":{"operationId":"finance_frankiefinancial_create_check_entity_push_to_mobile","summary":"Create Entity and Push Self-Verification Link","description":"POST /entity/new/verify/pushToMobile","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"boolean","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/create-check-entity":{"post":{"operationId":"finance_frankiefinancial_create_check_entity","summary":"Create and Verify Entity","description":"POST /entity/new/verify/{checkType}/{resultLevel}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","checkType","resultLevel","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","default":"default","description":"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":{"type":"string","enum":["simple","summary","full"],"description":"How much detail we return. Acceptable values are: * simple - Only available with \"profile\" check type. Returns just an…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/search-entity":{"post":{"operationId":"finance_frankiefinancial_search_entity","summary":"Search for Entity","description":"POST /entity/search","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/query-entity":{"get":{"operationId":"finance_frankiefinancial_query_entity","summary":"Retrieve Entity Details","description":"GET /entity/{entityId}","tags":["finance"],"parameters":[{"name":"X-Frankie-CustomerID","in":"query","required":true,"description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.","schema":{"type":"string","description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time."}},{"name":"X-Frankie-CustomerChildID","in":"query","required":false,"description":"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.…","schema":{"type":"string","description":"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.…"}},{"name":"entityId","in":"query","required":true,"description":"The entityId returned previously from an earlier call to /check or /entity","schema":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-entity":{"post":{"operationId":"finance_frankiefinancial_update_entity","summary":"Update Existing Entity.","description":"POST /entity/{entityId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"noInvalidate":{"type":"boolean","description":"Disable check result invalidation for this update request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/delete-entity":{"post":{"operationId":"finance_frankiefinancial_delete_entity","summary":"Delete Entity","description":"DELETE /entity/{entityId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-check-class-results":{"post":{"operationId":"finance_frankiefinancial_update_check_class_results","summary":"Update Check Result States (Batch)","description":"POST /entity/{entityId}/check/{checkId}/{checkClass}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","checkId","checkClass","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"checkId":{"type":"string","description":"The checkId returned previously from an earlier call to */verify"},"checkClass":{"type":"string","enum":["pro","bcro","fraudlist"],"description":"Specify which check Class this action will apply to (PRO, BCRO etc.). Valid values are: - \"pro\": Update a Process Result Object - \"bcro\":…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-check-class-result":{"post":{"operationId":"finance_frankiefinancial_update_check_class_result","summary":"Update Check Result State","description":"POST /entity/{entityId}/check/{checkId}/{checkClass}/{checkClassId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","checkId","checkClass","checkClassId","status"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"checkId":{"type":"string","description":"The checkId returned previously from an earlier call to */verify"},"checkClass":{"type":"string","enum":["pro","bcro","fraudlist"],"description":"Specify which check Class this action will apply to (PRO, BCRO etc.). Valid values are: - \"pro\": Update a Process Result Object - \"bcro\":…"},"checkClassId":{"type":"string","description":"A PRO/BCRO ID"},"status":{"type":"string","description":"Set the new status of the Check Class (PRO/BCRO). Valid values are: - \"unknown\" - \"true_positive\" - \"true_positive_accept\" -…"},"undo":{"type":"boolean","description":"Undo a prior operation."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/query-entity-checks":{"get":{"operationId":"finance_frankiefinancial_query_entity_checks","summary":"Retrieve Entity Verication Check Details","description":"GET /entity/{entityId}/checks","tags":["finance"],"parameters":[{"name":"X-Frankie-CustomerID","in":"query","required":true,"description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.","schema":{"type":"string","description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time."}},{"name":"X-Frankie-CustomerChildID","in":"query","required":false,"description":"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.…","schema":{"type":"string","description":"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.…"}},{"name":"entityId","in":"query","required":true,"description":"The entityId returned previously from an earlier call to /check or /entity","schema":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"}},{"name":"alldata","in":"query","required":false,"description":"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…","schema":{"type":"boolean","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/blacklist-entity":{"post":{"operationId":"finance_frankiefinancial_blacklist_entity","summary":"Set Entity Blacklist State.","description":"POST /entity/{entityId}/flag/blacklist","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","set"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"set":{"type":"boolean","description":"Set the value of an entity flag."},"reason":{"type":"string","description":"Set the reason for blacklisting. Valid values are: - \"NO_REASON_SUPPLIED\" - \"FABRICATED_IDENTITY\" - \"IDENTITY_TAKEOVER\" -…"},"blockedBy":{"type":"string","description":"Specify who is setting the entity as blacklisted."},"attribute":{"type":"string","description":"Specify the blacklisted attribute. Valid values are: - \"ENTIRE_PROFILE\" - \"FULL_NAME\" - \"EMAIL_ADDRESS\" - \"PHONE_NUMBER\" - \"ID_DOCUMENT\" -…"},"originalId":{"type":"string","description":"Specify the Id of the matching blacklisted entity or single data-point."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/flag-duplicate-entity":{"post":{"operationId":"finance_frankiefinancial_flag_duplicate_entity","summary":"Resolve Duplicate States.","description":"POST /entity/{entityId}/flag/duplicate/{otherId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","otherId","set"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"otherId":{"type":"string","description":"An entityId returned previously from an earlier call to /check or /entity. Used when an operation requires two entityIds"},"set":{"type":"boolean","description":"Set the value of an entity flag."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/entity-monitoring":{"post":{"operationId":"finance_frankiefinancial_entity_monitoring","summary":"Set Entity Ongoing AML Monitoring Status.","description":"POST /entity/{entityId}/flag/monitor","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","set"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"set":{"type":"boolean","description":"Set the value of an entity flag."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/watchlist-entity":{"post":{"operationId":"finance_frankiefinancial_watchlist_entity","summary":"Set Entity Watchlist State.","description":"POST /entity/{entityId}/flag/watchlist","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","set"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"set":{"type":"boolean","description":"Set the value of an entity flag."},"reason":{"type":"string","description":"Set the reason for watchlisting. Valid values are: - \"WAS_BLACKLISTED\""},"comment":{"type":"string","description":"A comment describing the reason for a request."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/query-entity-full":{"get":{"operationId":"finance_frankiefinancial_query_entity_full","summary":"Retrieve Entity Details and Document Scan Data","description":"GET /entity/{entityId}/full","tags":["finance"],"parameters":[{"name":"X-Frankie-CustomerID","in":"query","required":true,"description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.","schema":{"type":"string","description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time."}},{"name":"X-Frankie-CustomerChildID","in":"query","required":false,"description":"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.…","schema":{"type":"string","description":"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.…"}},{"name":"entityId","in":"query","required":true,"description":"The entityId returned previously from an earlier call to /check or /entity","schema":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-entity-get-idvtoken":{"post":{"operationId":"finance_frankiefinancial_update_entity_get_idvtoken","summary":"Update Entity and Get IDV Token","description":"POST /entity/{entityId}/idvalidate/getToken","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-entity-init-idvprocess":{"post":{"operationId":"finance_frankiefinancial_update_entity_init_idvprocess","summary":"Update Entity and Initiate IDV Process","description":"POST /entity/{entityId}/idvalidate/initProcess","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-entity-state":{"post":{"operationId":"finance_frankiefinancial_update_entity_state","summary":"Update Entity States","description":"POST /entity/{entityId}/status","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"set":{"type":"string","enum":["wait","fail","archived","clear","inactive"],"description":"The status of an entity. Valid values are: - \"wait\": Waiting for new details from entity. - \"fail\": Manually fail the onboarding process.…"},"risk":{"type":"string","enum":["low","medium","high","unacceptable","significant"],"description":"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":{"type":"string","description":"A comment describing the reason for a request."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-check-entity-push-to-mobile":{"post":{"operationId":"finance_frankiefinancial_update_check_entity_push_to_mobile","summary":"Update Entity and Push Self-Verification Link","description":"POST /entity/{entityId}/verify/pushToMobile","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"nopush":{"type":"boolean","description":"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":{"type":"integer","description":"Set the Push To Mobile phase. Currently supported values: - 2"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/update-check-entity":{"post":{"operationId":"finance_frankiefinancial_update_check_entity","summary":"Update Entity and Verify Details","description":"POST /entity/{entityId}/verify/{checkType}/{resultLevel}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-Frankie-CustomerID","entityId","checkType","resultLevel","body"],"properties":{"X-Frankie-CustomerID":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The entityId returned previously from an earlier call to /check or /entity"},"checkType":{"type":"string","default":"default","description":"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":{"type":"string","enum":["simple","summary","full"],"description":"How much detail we return. Acceptable values are: * simple - Only available with \"profile\" check type. Returns just an…"},"force":{"type":"boolean","description":"Force the verification to run, overriding any data aging or past check"},"noInvalidate":{"type":"boolean","description":"Disable check result invalidation for this update request."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/retrieve-result":{"get":{"operationId":"finance_frankiefinancial_retrieve_result","summary":"(Re)retrieve Response Result.","description":"GET /retrieve/response/{requestId}","tags":["finance"],"parameters":[{"name":"X-Frankie-CustomerID","in":"query","required":true,"description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.","schema":{"type":"string","description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time."}},{"name":"X-Frankie-CustomerChildID","in":"query","required":false,"description":"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.…","schema":{"type":"string","description":"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.…"}},{"name":"requestId","in":"query","required":true,"description":"This will be the same RequestId that was sent in the 202 acceptance response.","schema":{"type":"string","description":"This will be the same RequestId that was sent in the 202 acceptance response."}},{"name":"payload","in":"query","required":false,"description":"Specifies the type of the payload field in the retrieved response. Default is 'string'.","schema":{"type":"string","enum":["string","object"],"description":"Specifies the type of the payload field in the retrieved response. Default is 'string'."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/status-check":{"get":{"operationId":"finance_frankiefinancial_status_check","summary":"Service Status","description":"GET /ruok","tags":["finance"],"parameters":[{"name":"askingNicely","in":"query","required":false,"description":"If set to true, the request is being made politely.","schema":{"type":"boolean","description":"If set to true, the request is being made politely."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:frankiefinancial/notify-result":{"post":{"operationId":"finance_frankiefinancial_notify_result","summary":"Push Notification Payload","description":"POST /your/configured/path/{requestId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["requestId"],"properties":{"requestId":{"type":"string","description":"This will be the same RequestId that was sent in the 202 acceptance response."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}