Iron API - Sandbox
- GETGet the pending authentication code for an entity
- PUTSubmit an authentication code
- GETGet all Customers
- POSTCreate a new customer
- GETGet a customer by external ID
- GETGet a customer by ID
- PUTUpdate a customer
- GETGet customer abilities
- GETGet all customer Identifications
- POSTCreate customer identification
- POSTCreate Customer Identification V2
- GETGet customer required signings
- GETGet all customer Signings
- POSTCreate a new Customer signing
- GETGet customer unsigned documents
- GETGet an Identification by ID
- GETFetch identification compliance questionnaire
- GET
curl --request GET \
--url https://api.sandbox.iron.xyz/api/customers/{id}/abilities \
--header 'X-API-Key: <api-key>' \
--header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'{
"fiat_deposit": {
"eur": {
"sepa": "Active",
"sepa_thirdparty": "Active"
},
"gbp": {
"chaps": "Active",
"chaps_thirdparty": "Active",
"fps": "Active",
"fps_thirdparty": "Active"
},
"usd": {
"ach": "Active",
"ach_thirdparty": "Active",
"rtp": "Active",
"rtp_thirdparty": "Active",
"swift": "Active",
"swift_thirdparty": "Active",
"wire": "Active",
"wire_thirdparty": "Active"
}
},
"fiat_payout": {
"eur": {
"sepa": "Active",
"sepa_thirdparty": "Active"
},
"gbp": {
"chaps": "Active",
"chaps_thirdparty": "Active",
"fps": "Active",
"fps_thirdparty": "Active"
},
"usd": {
"ach": "Active",
"ach_thirdparty": "Active",
"rtp": "Active",
"rtp_thirdparty": "Active",
"swift": "Active",
"swift_thirdparty": "Active",
"wire": "Active",
"wire_thirdparty": "Active"
}
}
}Get customer abilities
Retrieve the abilities/capabilities for a specific customer by ID
curl --request GET \
--url https://api.sandbox.iron.xyz/api/customers/{id}/abilities \
--header 'X-API-Key: <api-key>' \
--header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'{
"fiat_deposit": {
"eur": {
"sepa": "Active",
"sepa_thirdparty": "Active"
},
"gbp": {
"chaps": "Active",
"chaps_thirdparty": "Active",
"fps": "Active",
"fps_thirdparty": "Active"
},
"usd": {
"ach": "Active",
"ach_thirdparty": "Active",
"rtp": "Active",
"rtp_thirdparty": "Active",
"swift": "Active",
"swift_thirdparty": "Active",
"wire": "Active",
"wire_thirdparty": "Active"
}
},
"fiat_payout": {
"eur": {
"sepa": "Active",
"sepa_thirdparty": "Active"
},
"gbp": {
"chaps": "Active",
"chaps_thirdparty": "Active",
"fps": "Active",
"fps_thirdparty": "Active"
},
"usd": {
"ach": "Active",
"ach_thirdparty": "Active",
"rtp": "Active",
"rtp_thirdparty": "Active",
"swift": "Active",
"swift_thirdparty": "Active",
"wire": "Active",
"wire_thirdparty": "Active"
}
}
}Authorizations
API Key
Headers
Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner
Path Parameters
the ID of the Customer to GET abilities for
Response
GET Customer Abilities Succeeded
Customer Abilities
Represents the abilities/capabilities that a customer has
Fiat rails Customer's ability to use fiat deposit and payout rails
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance Show child attributes
Show child attributes
The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance Show child attributes
Show child attributes
The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance Fiat rails Customer's ability to use fiat deposit and payout rails
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance Show child attributes
Show child attributes
The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance The current status of the ability
Active, Pending, Unavailable, Blocked, Maintenance