Phin Security icon

Phin Security

The Phin Security API allows partners to access their data programmatically. It provides endpoints for managing companies, retrieving historical phishing and training data, accessing reporting artifacts, and viewing usage information. The API must be enabled through the Phin Portal. Authentication uses OAuth2 Client Credentials flow via Auth0.

Actions10

Companies → Create a company for a partner

AI-generated

Summary

Creates a new company under a partner account via POST /partners/{partnerId}/companies.

Inputs

  • partnerId (required) — Your Phin Partner ID
  • name (required) — The name of the company to create
  • customBody — Optional. Deep-merged with the name field; custom body values take priority. Leave as {} to skip.
  • headerFilters — Add custom HTTP headers to the request.
  • queryFilters — Add query-string filters. Set the parameter name and value for each filter.
  • debug — When enabled, includes the actual URL, query parameters, headers, and body sent for each API request in the output under a debug entry.
  • timeout — Timeout in milliseconds. Default is 300000 (5 minutes).

Output shape

object

The Phin API response, typically the created company object. If debug is enabled, the output includes a debug entry with request details alongside the response.

Examples

Example 1: Create a company named 'Acme Corp' under partner ID 'P12345'.

partnerId: 'P12345'; name: 'Acme Corp'. Defaults used for optional parameters.

Links

Discussion