Onboarding Buddy API Endpoints and Use Cases

Explore the Onboarding Buddy API with detailed endpoints and practical use cases for validation, file management, and sanctions checks, designed for developers and compliance-focused applications.

API Endpoints

Endpoint	Method	Purpose
`/validation-service/validation/email`	POST	Validates a single email address and returns the validation response.
`/validation-service/batch/email-address`	POST	Validates a batch of email addresses and returns a batch validation response.
`/validation-service/batch/poll/{batchId}`	GET	Polls the status of a submitted batch validation request using the batch ID.
`/validation-service/batch/email-address/{batchId}`	GET	Retrieves the validation results for a batch of email addresses using the batch ID.
`/validation-service/validation/mobile`	POST	Validates a single mobile number and returns the validation response.
`/validation-service/batch/mobile`	POST	Validates a batch of mobile numbers and returns a batch validation response.
`/validation-service/batch/mobile/{batchId}`	GET	Retrieves the validation results for a batch of mobile numbers using the batch ID.
`/validation-service/validation/ipaddress`	POST	Validates a single IP address and returns the validation response.
`/validation-service/batch/ip-address`	POST	Validates a batch of IP addresses and returns a batch validation response.
`/validation-service/batch/ip-address/{batchId}`	GET	Retrieves the validation results for a batch of IP addresses using the batch ID.
`/validation-service/validation/browser`	POST	Validates a single browser user agent and returns the validation response.
`/validation-service/batch/browser`	POST	Validates a batch of browser user agents and returns a batch validation response.
`/validation-service/batch/browser/{batchId}`	GET	Retrieves the validation results for a batch of browser user agents using the batch ID.
`/file-service/upload`	POST	Uploads a user file and returns metadata for the uploaded file.
`/file-service/download/{fileGlobalId}`	GET	Retrieves download information, including a pre-signed URL, for a specified file using the file global ID.
`/file-service/generate/image`	POST	Generates an image file based on a provided prompt and returns the generation request details.
`/file-service/generate/video`	POST	Generates a video file based on a prompt or an image and prompt, returning the generation request details.
`/file-service/generate/poll/{globalId}`	GET	Polls the status of a file generation request using the file global ID.
`/file-service/management/{fileGlobalId}`	GET	Retrieves metadata for a specific file using the file global ID.
`/file-service/management/{fileGlobalId}`	DELETE	Deletes a specific file record using the file global ID.
`/file-service/management`	GET	Retrieves a list of file records for the organization.
`/file-service/search`	POST	Searches for file records using vector search parameters and returns matching files.
`/file-service/query/rag`	POST	Performs a Retrieval-Augmented Generation (RAG) query on a specified file, returning generated content.
`/sanction-service/check/individual`	POST	Performs a sanctions check for an individual and returns the sanctions list response.
`/sanction-service/check/entity`	POST	Performs a sanctions check for an entity and returns the sanctions list response.
`/sanction-service/check/crypto-wallet`	POST	Performs a sanctions check for a crypto wallet address and returns the sanctions list response.
`/sanction-service/check/vessel`	POST	Performs a sanctions check for a vessel and returns the sanctions list response.
`/sanction-service/check/aircraft`	POST	Performs a sanctions check for an aircraft and returns the sanctions list response.

API Use Cases

Use Case Title	Description	Relevant Endpoint(s)
Validate Email Addresses	Verify the validity of email addresses to ensure accurate user data, check for disposable domains, and confirm MX records for onboarding or compliance.	`POST /validation-service/validation/email` `POST /validation-service/batch/email-address` `GET /validation-service/batch/poll/{batchId}` `GET /validation-service/batch/email-address/{batchId}`
Validate Mobile Numbers	Check mobile numbers for validity, format, carrier, and line type to enhance user verification processes in registration or authentication flows.	`POST /validation-service/validation/mobile` `POST /validation-service/batch/mobile` `GET /validation-service/batch/poll/{batchId}` `GET /validation-service/batch/mobile/{batchId}`
Validate IP Addresses	Assess IP addresses for geolocation, threat levels, and VPN/Tor usage to ensure secure user interactions and detect potential fraud.	`POST /validation-service/validation/ipaddress` `POST /validation-service/batch/ip-address` `GET /validation-service/batch/poll/{batchId}` `GET /validation-service/batch/ip-address/{batchId}`
Validate Browser User Agents	Analyze browser user agents to identify software, operating systems, and abusive behavior for secure session management and fraud prevention.	`POST /validation-service/validation/browser` `POST /validation-service/batch/browser` `GET /validation-service/batch/poll/{batchId}` `GET /validation-service/batch/browser/{batchId}`
Upload User Files	Allow users to upload files (e.g., documents, images) securely, storing them with metadata for use in onboarding or verification processes.	`POST /file-service/upload`
Download Files	Retrieve files securely using a pre-signed URL, enabling access to previously uploaded or generated files for user or admin purposes.	`GET /file-service/download/{fileGlobalId}`
Generate Images	Create images based on text prompts for use in marketing, user interfaces, or documentation within your application.	`POST /file-service/generate/image` `GET /file-service/generate/poll/{globalId}`
Generate Videos	Produce videos from prompts or images for dynamic content creation, such as tutorials or promotional materials.	`POST /file-service/generate/video` `GET /file-service/generate/poll/{globalId}`
Manage File Metadata	Retrieve or delete file metadata to manage storage, track file usage, or clean up obsolete files for organizational efficiency.	`GET /file-service/management/{fileGlobalId}` `DELETE /file-service/management/{fileGlobalId}` `GET /file-service/management`
Search Files	Perform vector-based searches to locate files based on content or metadata, useful for document retrieval or content management.	`POST /file-service/search`
Document-Based Query (RAG)	Use Retrieval-Augmented Generation to query specific files and generate contextual responses, ideal for intelligent document processing.	`POST /file-service/query/rag`
Check Individuals for Sanctions	Screen individuals against sanctions lists to ensure compliance with regulatory requirements during onboarding or transactions.	`POST /sanction-service/check/individual`
Check Entities for Sanctions	Verify organizations or businesses against sanctions lists to mitigate compliance risks in partnerships or financial dealings.	`POST /sanction-service/check/entity`
Check Crypto Wallets for Sanctions	Validate cryptocurrency wallet addresses against sanctions lists to ensure compliance in blockchain-related applications.	`POST /sanction-service/check/crypto-wallet`
Check Vessels for Sanctions	Screen vessels for sanctions to ensure compliance in maritime or logistics operations.	`POST /sanction-service/check/vessel`
Check Aircraft for Sanctions	Verify aircraft against sanctions lists to ensure compliance in aviation-related operations.	`POST /sanction-service/check/aircraft`