Introduction to the API

The FrankieOne API enables seamless integration of comprehensive risk and compliance services into your applications, offering global identity verification and business validation capabilities.

Outbound IP Addresses

Traffic from FrankieOne originates from the following IP addresses.

You must whitelist the three Production IP addresses.

Testing (demo and UAT)
  • 52.62.31.108
  • 149.167.70.106
  • 123.103.207.82
Production
  • 13.236.159.198
  • 13.237.83.115
  • 16.50.141.56
Inbound IP Addresses

We currently don’t support inbound IP address filtering, so you can’t limit what IP address would be able to authenticate using your FrankieOne API credentials.

Key Capabilities

Swagger / OpenAPI definition

Download our latest Swagger / OpenAPI definition here.

Swagger documentation

View our Swagger documentation here.

Document Verification
  • Validate international IDs, passports, and licenses
  • Support for 100+ countries
  • Automatic data extraction
Biometric Verification
  • Selfie-to-ID matching
  • Liveness detection
  • Anti-spoofing protection
Background Screening
  • PEP & Sanctions checks
  • Adverse media screening
  • Real-time monitoring
Fraud Prevention
  • Duplicate detection
  • Custom blocklists
  • Network intelligence
1

Company Analysis

  • Verify business registration
  • Analyze ownership structure
  • Access credit reports
2

Stakeholder Verification

  • Identify beneficial owners
  • Verify directors and officers
  • Conduct KYC checks
3

Ongoing Monitoring

  • Track company changes
  • Monitor stakeholders
  • Alert on status updates

API Fundamentals

The API follows RESTful conventions with JSON payloads over HTTPS. We’ve kept it simple with three main HTTP methods:

GET    → Retrieve data
POST   → Create or update resources
DELETE → Remove resources

All API responses include unique IDs (UUIDs) for created resources. Store these IDs - you’ll need them for updates!

Working with Resources

1POST /v1/entity
2{
3  "name": {
4    "givenName": "John",
5    "familyName": "Doe",
6    "displayName": "J Doe"
7  },
8  "addresses": [
9    {
10      "streetNumber": "123",
11      "streetName": "Main St",
12      "city": "Sydney",
13      "country": "AUS"
14    }
15  ]
16}

The API automatically generates UUIDs for all created resources, including nested objects like addresses and documents.

When updating resources:

  1. Always include the resource ID in both the URL and payload
  2. Provide complete objects for updates (partial updates aren’t supported)
  3. Only include the objects you want to modify
Update Example
1POST /v1/entity/12345678-4321-1234-4321-123456789012
2{
3  "entityId": "12345678-4321-1234-4321-123456789012",
4  "addresses": [
5    {
6      "addressId": "876543231-1234-4321-1234-210987654321",
7      "streetNumber": "456",
8      "streetName": "New St",
9      "city": "Melbourne",
10      "country": "AUS"
11    }
12  ]
13}

Performing Verifications

Simple Verification
POST /entity/new/verify/profile/simple

Creates entity and runs basic checks

Full Verification
POST /entity/{id}/verify/profile/full

Comprehensive checks

Remember to handle API responses appropriately. All verification endpoints return detailed result objects that should be processed for a complete verification flow.

API Endpoints

Environment Access

Testing environment is available for all users, while UAT and Production environments are restricted to contracted customers only.

Use this environment for initial development and testing. It’s free to access and perfect for integration testing.

API
https://api.demo.frankiefinancial.io
OneSDK + Smart UI
https://backend.demo.frankiefinancial.io
Portal
https://demo.frankiefinancial.io
  • Start with the Testing/Sandbox environment during development - Move to UAT once you’re ready for integration testing (contracted customers)
  • Use Production only when you’re fully tested and ready to go live
Built with