Unstoppable Finance (Iron) Customer API
Operations on Customers
Unstoppable Finance (Iron) Customer API is one of 9 APIs that Unstoppable Finance (Iron) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 20 operations across 17 paths, and defines 102 schemas. It is described by OpenAPI 3.1.0, at version 1.0-16988.
Requests are made against a single base URL, https://api.sandbox.iron.xyz/api.
20 operations
17 paths
102 schemas
13 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Unstoppable Finance (Iron) Customer API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-Key (ApiKeyAuth).
ApiKeyAuth— API Key
Paths & Operations 20
Across 17 paths, the API surfaces 20 operations — 13 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Customer 20
Operations on Customers
GET
/authentication-codes/entity/{id}
Get the pending authentication code for an entity
PUT
/authentication-codes/{id}
Submit an authentication code
GET
/customers
Get all Customers
POST
/customers
Create a new customer
GET
/customers/{external_id}/external
Get a customer by external ID
GET
/customers/{id}
Get a customer by ID
PUT
/customers/{id}
Update a customer
GET
/customers/{id}/abilities
Get customer abilities
PUT
/customers/{id}/archive
Archive a customer
GET
/customers/{id}/identifications
Get all customer Identifications
POST
/customers/{id}/identifications/v2
Create Customer Identification V2
GET
/customers/{id}/microdeposits
Get customer microdeposits
GET
/customers/{id}/required-signings
Get customer required signings
GET
/customers/{id}/requirements
Get customer requirements
GET
/customers/{id}/signings
Get all customer Signings
POST
/customers/{id}/signings
Create a new Customer signing
GET
/customers/{id}/spending-limit
Get customer spending limit usage
GET
/identifications/{id}
Get an Identification by ID
PUT
/identifications/{id}/archive
Archive an identification
GET
/identifications/{id}/compliance-questionnaire
Fetch identification compliance questionnaire
Schemas 102
The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are IdentificationPersonParams (15 properties), Customer (14 properties), PersonBeneficiaryInfo (12 properties), CompanyInfo (12 properties). Each schema is shown below with its type and property counts.
BusinessQuestionnaire_GenericBusinessQuestionnaire
KYB compliance questionnaire Use GenericBusinessQuestionnaire for all company types except sole proprietorships. Use SolePropBusinessQuestionnaire for sole pro…
Customer
object
Customer The customer object in Iron
14 properties
10 required
CustomerRequirements
object
Bridge-style requirements view of a customer. All four buckets are always present (may be empty). requirementsdue is a quick coarse summary — partners can use…
5 properties
5 required
Currency_Fiat
Currency Can be either crypto or fiat
IdentificationCreateParamsV2_IdentificationTokenParams
Identification Create Params V2 The params required to create an identification v2, we support three types of identification: - Link: where a link is provided…
SolePropBusinessDetails
object
Sole Prop Business Details Section
4 properties
4 required
SolePropSourceOfFunds
object
Sole Prop Source of Funds Section
1 property
1 required
IdentificationBusinessParams
object
Business Identification Params The params required to create an identification
4 properties
4 required
IdentificationCreateParamsV2_IdentificationBusinessParams
Identification Create Params V2 The params required to create an identification v2, we support three types of identification: - Link: where a link is provided…
Identification
object
Identification The entity wrapping our KYC/KYB process and underlying providers
11 properties
4 required
SigningCreateParams
object
Params for Creating a Signing
2 properties
1 required
RejectReason
object
A Sumsub rejection reason: the stable code paired with a human-readable description, so partners can display the reason without maintaining their own code→text…
2 properties
2 required
PersonProfileSourceOfWealth
string
Source of Wealth The source of wealth of the person
CustomerStatus
string
The status of the Customer
AuthenticationCode
object
An authentication code used to confirm a 2FA action
5 properties
5 required
BusinessQuestionnaireBusinessDetails
object
Business Details Section Industry classification and operational information about the company
6 properties
6 required
Occupation
string
Occupation The occupation of the person
Signing
object
Signing A signing of a document by a customer
6 properties
4 required
GenericBusinessQuestionnaire
object
KYB compliance questionnaire for standard company types
3 properties
3 required
BusinessBeneficiaryInfo
object
Business Beneficiary Info A company that itself owns or controls the parent business. Carries the same ApiCompanyData as the root identification: company info,…
1 property
1 required
CustomerType
string
CustomerType Customers can either be a commercial business or a natural person
BeneficiaryIdentity
object
Beneficiary Identity Document Identity document and biometric information for a person beneficiary. Mirrors ApiPersonIdentity but excludes ipaddress (collected…
8 properties
4 required
EddQuestionnaire
object
EDD Questionnaire The questionnaire for a reliance person residing in a country considered high risk
3 properties
3 required
Crypto
object
A cryptocurrency
2 properties
2 required
Currency
object
Currency Can be either crypto or fiat
CompanyBeneficiary
object
Company Beneficial Owner The beneficial owner of the company
5 properties
2 required
PersonBeneficiaryInfo
object
Company Person Beneficiary Info The beneficiary info of the person
12 properties
9 required
BusinessPurposeAndIntendedUse
string
Purpose and Intended Use The intended purpose of the business account
IdentificationPersonParams
object
Person Identification Params The params required to create an identification
15 properties
12 required
PersonProfileExpectedMonthlyTransactionCount
string
Expected Monthly Transaction Count The expected monthly transaction volume of the person
IdentificationStepStatus
object
CurrencyAbility
object
What a customer can do with a single currency. currency reuses the shared ApiCurrency type; flows reuses AutorampType. The flow rules live in currencyabilities…
3 properties
3 required
BusinessEstimatedMonthlyVolume
string
Estimated Monthly Transaction Volume Expected monthly transaction volume in EUR
AutorampType
string
Autoramp type The type (onramp, offramp, swap) of an autoramp
RequirementCode
string
Stable, switchable identifier for a single requirement. Partners should branch on this rather than parsing description, which holds the verbatim text from Sums…
IdentificationTokenParams
object
Token Identification Params The params required to create an identification
5 properties
2 required
IdentityDocumentType
string
Identity Document Type The type of identity document useful to KYB process
BusinessQuestionnaire_SolePropBusinessQuestionnaire
KYB compliance questionnaire Use GenericBusinessQuestionnaire for all company types except sole proprietorships. Use SolePropBusinessQuestionnaire for sole pro…
SortOrder
string
UsdAbilities
object
10 properties
10 required
CompanyBeneficiaryInfo
object
Company Beneficiary Info The beneficiary info of the company
Blockchain
string
Blockchain A type of blockchain
AuthenticationCodeStatus
string
The status of the Authentication Code
BusinessQuestionnaire
object
KYB compliance questionnaire Use GenericBusinessQuestionnaire for all company types except sole proprietorships. Use SolePropBusinessQuestionnaire for sole pro…
BusinessIdentificationStepStatus
object
4 properties
CompanyPrimaryBeneficiaryRole
string
Beneficial Owner Role The role of the beneficial owner in the company
ApiError
object
Standard error response returned to API clients for server errors. Includes a traceid that clients can reference when reporting issues.
2 properties
2 required
IntendedUse
string
Intended Purpose The intended purpose the person wants to use the account for
BusinessQuestionnaireSourceOfFunds
object
Source of Funds Section Information about where the company's funds originate
3 properties
3 required
BusinessEstimatedMonthlyTransactions
string
Estimated Monthly Transaction Count Expected number of transactions per month
CustomerAbilities
object
Customer Abilities Represents the abilities/capabilities that a customer has
3 properties
3 required
UpdateCustomerParams
object
Update Customer Params Parameters for updating a customer
2 properties
1 required
PersonProfileSourceOfFunds
string
Source of Funds The sources of funds for a person
PersonProfileYearlyGrossIncome
string
Yearly Gross Income The yearly gross income of the person
PersonIdentity
object
Person Identity The required identity information of a person
9 properties
7 required
ComplianceQuestionaire
object
V1 Compliance Questionnaire Legacy compliance questionnaire format
8 properties
2 required
ApiFiatAbilities
object
Fiat rails Customer's ability to use fiat deposit and payout rails
3 properties
3 required
CompanyDocParams
object
Company document params The params required to create a company document
3 properties
3 required
CreateCustomerParams
object
Customer Params Parameters for creating a customer
4 properties
2 required
BusinessQuestionnairePlannedActivities
object
Planned Activities Section Information about the company's intended account use and transaction patterns
7 properties
4 required
CustomerSpendingLimit
object
Customer Spending Limit Current usage of the rolling 52-week spending limit split by direction.
2 properties
2 required
EurAbilities
object
4 properties
4 required
PagedList_Signing
object
PagedList A list of items with cursors used to fetch the next or previous page
3 properties
1 required
PersonProfileMonthlyIncome
string
Monthly Income The monthly income of the person
MissingQuestion
object
A required questionnaire question the customer has left unanswered, resolved against the Sumsub questionnaire definition.
3 properties
2 required
PagedList_Customer
object
PagedList A list of items with cursors used to fetch the next or previous page
3 properties
1 required
Fiat
object
A fiat currency
1 property
1 required
AbilityStatus
string
The current status of the ability
IdentificationCreateParamsV2_IdentificationPersonParams
Identification Create Params V2 The params required to create an identification v2, we support three types of identification: - Link: where a link is provided…
SolePropBusinessQuestionnaire
object
KYB compliance questionnaire for sole proprietorships
3 properties
3 required
GbpAbilities
object
6 properties
6 required
Address
object
Address
6 properties
4 required
CompanyDocType
string
Company document type The type of company document
DocumentType
string
Document Type The type of document used in the KYB process
IdentityDocument
object
Identity Document A base64 document that can be used to identify the business
3 properties
3 required
CompanyType
string
Company Type The type of company
EmploymentStatus
string
Employment Status The employment status of the person
ApproximateNetWorth
string
Approximate Net Worth The approximate net worth of the person
RevenueSource
string
Revenue Source Primary source of company funds
CompanyData
object
Company Data Full company submission: identifying info, beneficiaries, and supporting documents. Reused by the root identification request and by each nested b…
3 properties
3 required
CustomerSpendingLimitSection
object
Customer Spending Limit Section Usage of the rolling 52-week spending limit for a single direction (fiat on-ramp or crypto off-ramp). Amounts are returned in E…
5 properties
3 required
PagedList_Identification
object
PagedList A list of items with cursors used to fetch the next or previous page
3 properties
1 required
SolePropPlannedActivities
object
Sole Prop Planned Activities Section
3 properties
3 required
RequirementItem
object
A single requirement entry returned in one of the four buckets on ApiCustomerRequirements.
7 properties
4 required
PersonProfileExpectedMonthlyTransactionVolume
string
Expected Monthly Transaction Volume The expected monthly transaction volume of the person
KycQuestionnaire
object
KYC Questionnaire The questionnaire for a person
5 properties
5 required
SubmitAuthenticationCodeParams
object
Authentication Code Params Parameters for submitting an authentication code
1 property
1 required
IdentificationLinkparams
object
Direct Identification Params The params required to create an identification
1 property
Currency_Crypto
Currency Can be either crypto or fiat
Microdeposit
object
Microdeposit A microdeposit record for account verification
4 properties
3 required
BirthPlace
object
Birth place The place of birth of the person
3 properties
3 required
IdentificationStatus
string
The Process status of the identification The various state transitions an identification can go through.
TermsAndConditionsLink
object
A terms and conditions link
3 properties
3 required
PersonIdentificationStepStatus
object
4 properties
VerificationStepDetail
object
3 properties
2 required
RequirementCategory
string
Coarse summary of which areas of the customer's Sumsub KYC/KYB process still need attention. Used as a quick filter — full detail lives in the four complete/pe…
PersonProfileExpectedMonthlyTransactionVolumeV2
string
CompanyInfo
object
Company Info Identifying details about a company. Shared between the root identification request and any nested business beneficiaries so the same fields are c…
12 properties
11 required
IdentificationCreateParamsV2
object
Identification Create Params V2 The params required to create an identification v2, we support three types of identification: - Link: where a link is provided…
BusinessEstimatedAnnualRevenue
string
Estimated Annual Revenue Company's estimated annual revenue in EUR
IdentificationCreateParamsV2_IdentificationLinkparams
Identification Create Params V2 The params required to create an identification v2, we support three types of identification: - Link: where a link is provided…
BusinessIndustryType
string
Industry Type Business industry/sector classification
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Unstoppable Finance (Iron) 8
Other APIs Unstoppable Finance (Iron) publishes across the network.
Unstoppable Finance (Iron) Addresses API
Unstoppable Finance (Iron) Autoramp API
Unstoppable Finance (Iron) Currencies API
Unstoppable Finance (Iron) ExchangeRate API
Unstoppable Finance (Iron) FeeProfiles API
Unstoppable Finance (Iron) Sandbox API
Unstoppable Finance (Iron) TermsAndConditions API
Unstoppable Finance (Iron) Webhooks API
#Customers
Where this information came from
This is an independent, third-party profile of Unstoppable Finance (Iron) Customer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.