Get details for an RFI
Copy
curl --request GET \
--url https://api.circle.com/v1/cpn/payments/{paymentId}/rfis/{rfiId} \
--header 'Authorization: Bearer <token>'Copy
{
"data": {
"id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"status": "APPROVED",
"level": "LEVEL_1",
"expireDate": "2023-01-01T12:04:05Z",
"certificate": {
"id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"certPem": "LS0tLS1CRUdJT...",
"domain": "api.circle.com",
"jwk": {
"crv": "P-256",
"kid": "263521881931753643998528753619816524468853605762",
"kty": "EC",
"x": "KnxBe8fb2mL_Ve9-tqjGSkGgE9f0yohMkAvH_InaFtE",
"y": "D41cVUpiKcey4LJKNFtUtmVHDWRmhjZapPLfryX5b1o"
}
},
"fieldRequirements": {
"version": 1,
"schema": {
"type": "object",
"$defs": {
"address": {
"type": "object",
"required": [
"street",
"city",
"country"
],
"properties": {
"city": {
"type": "string",
"description": "City name"
},
"street": {
"type": "string",
"description": "Street address"
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Country code (e.g., US, GB)"
},
"postalCode": {
"type": "string",
"description": "Postal or ZIP code"
},
"stateProvince": {
"type": "string",
"description": "State or province"
}
},
"description": "Full address"
},
"individual": {
"type": "object",
"required": [
"name",
"address",
"dateOfBirth"
],
"properties": {
"name": {
"type": "string",
"description": "Individual's full name"
},
"address": {
"ref": "#/$defs/address"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "Individual's date of birth (YYYY-MM-DD)"
}
},
"description": "Individual's RFI data"
},
"beneficiaryOwner": {
"type": "object",
"required": [
"name",
"address",
"dateOfBirth",
"percentage"
],
"properties": {
"name": {
"type": "string",
"description": "Individual's full name"
},
"address": {
"ref": "#/$defs/address"
},
"percentage": {
"type": "number",
"description": "Company ownership percentage"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "Individual's date of birth (YYYY-MM-DD)"
}
},
"description": "Beneficiary owner's RFI data"
},
"intermediaryBeneficiaryOwner": {
"type": "object",
"required": [
"name",
"address",
"dateOfFormation",
"countryOfFormation",
"percentage"
],
"properties": {
"name": {
"type": "string",
"description": "Business legal name"
},
"address": {
"ref": "#/$defs/address"
},
"percentage": {
"type": "number",
"description": "Company ownership percentage"
},
"dateOfFormation": {
"type": "string",
"format": "date",
"description": "Company formation date (YYYY-MM-DD)"
},
"countryOfFormation": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Entity formation country"
}
},
"description": "Intermediary beneficiary owner's RFI data"
}
},
"title": "RFI Requirements",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"SOURCE_OF_FUNDS",
"METHOD_OF_VERIFICATION",
"NAME",
"TRADE_NAME",
"NATIONAL_IDENTIFICATION_NUMBER",
"DATE_OF_FORMATION",
"COUNTRY_OF_FORMATION",
"ENTITY_TYPE",
"INDUSTRY_TYPE",
"ADDRESS",
"AUTHORIZED_SIGNATORIES",
"BENEFICIARY_OWNERSHIP"
],
"properties": {
"NAME": {
"type": "string",
"description": "Business legal registered name"
},
"EMAIL": {
"type": "string",
"description": "Business contact email address"
},
"PHONE": {
"type": "string",
"description": "Business contact phone number"
},
"ADDRESS": {
"ref": "#/$defs/address"
},
"WEBSITE": {
"type": "string",
"description": "Business website URL"
},
"TRADE_NAME": {
"type": "string",
"description": "Business trade name or DBA (Doing Business As)"
},
"ENTITY_TYPE": {
"type": "string",
"description": "Business structure type (Corporation, LLC, Partnership, etc.)"
},
"INDUSTRY_TYPE": {
"type": "string",
"description": "Business activity classification"
},
"SOURCE_OF_FUNDS": {
"type": "string",
"description": "Transaction source of funds"
},
"DATE_OF_FORMATION": {
"type": "string",
"format": "date",
"description": "Company formation date (YYYY-MM-DD)"
},
"BENEFICIARY_OWNERS": {
"ref": "#/$defs/beneficiaryOwner"
},
"COUNTRY_OF_FORMATION": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Entity formation country"
},
"BENEFICIARY_OWNERSHIP": {
"type": "boolean",
"description": "Whether any individuals or intermediaries own 25% or more of the company"
},
"AUTHORIZED_SIGNATORIES": {
"ref": "#/$defs/individual"
},
"METHOD_OF_VERIFICATION": {
"type": "string",
"description": "Verification method used"
},
"NATIONAL_IDENTIFICATION_NUMBER": {
"type": "string",
"description": "Business identification number (e.g., Tax ID)"
},
"INTERMEDIARY_BENEFICIARY_OWNERS": {
"ref": "#/$defs/intermediaryBeneficiaryOwner"
}
},
"description": "RFI Data Requirements"
}
},
"fileRequirements": [
"FORMATION_DOCUMENT"
]
}
}Requests for Information
Get details for an RFI
Retrieve details of a specific RFI for a payment. If the BFI initiates an RFI after the payment is created, the OFI will be notified via webhook. This webhook will detail what specific information the OFI needs to send.
After receiving the webhook. The OFI is expected to encrypt the requested data and send it to the BFI using CPN’s RFI submit endpoint. Failure to respond to an RFI will result in a failed payment. The OFI will receive webhooks with the decision based on the submitted information.
GET
/
v1
/
cpn
/
payments
/
{paymentId}
/
rfis
/
{rfiId}
Get details for an RFI
Copy
curl --request GET \
--url https://api.circle.com/v1/cpn/payments/{paymentId}/rfis/{rfiId} \
--header 'Authorization: Bearer <token>'Copy
{
"data": {
"id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"status": "APPROVED",
"level": "LEVEL_1",
"expireDate": "2023-01-01T12:04:05Z",
"certificate": {
"id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"certPem": "LS0tLS1CRUdJT...",
"domain": "api.circle.com",
"jwk": {
"crv": "P-256",
"kid": "263521881931753643998528753619816524468853605762",
"kty": "EC",
"x": "KnxBe8fb2mL_Ve9-tqjGSkGgE9f0yohMkAvH_InaFtE",
"y": "D41cVUpiKcey4LJKNFtUtmVHDWRmhjZapPLfryX5b1o"
}
},
"fieldRequirements": {
"version": 1,
"schema": {
"type": "object",
"$defs": {
"address": {
"type": "object",
"required": [
"street",
"city",
"country"
],
"properties": {
"city": {
"type": "string",
"description": "City name"
},
"street": {
"type": "string",
"description": "Street address"
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Country code (e.g., US, GB)"
},
"postalCode": {
"type": "string",
"description": "Postal or ZIP code"
},
"stateProvince": {
"type": "string",
"description": "State or province"
}
},
"description": "Full address"
},
"individual": {
"type": "object",
"required": [
"name",
"address",
"dateOfBirth"
],
"properties": {
"name": {
"type": "string",
"description": "Individual's full name"
},
"address": {
"ref": "#/$defs/address"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "Individual's date of birth (YYYY-MM-DD)"
}
},
"description": "Individual's RFI data"
},
"beneficiaryOwner": {
"type": "object",
"required": [
"name",
"address",
"dateOfBirth",
"percentage"
],
"properties": {
"name": {
"type": "string",
"description": "Individual's full name"
},
"address": {
"ref": "#/$defs/address"
},
"percentage": {
"type": "number",
"description": "Company ownership percentage"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "Individual's date of birth (YYYY-MM-DD)"
}
},
"description": "Beneficiary owner's RFI data"
},
"intermediaryBeneficiaryOwner": {
"type": "object",
"required": [
"name",
"address",
"dateOfFormation",
"countryOfFormation",
"percentage"
],
"properties": {
"name": {
"type": "string",
"description": "Business legal name"
},
"address": {
"ref": "#/$defs/address"
},
"percentage": {
"type": "number",
"description": "Company ownership percentage"
},
"dateOfFormation": {
"type": "string",
"format": "date",
"description": "Company formation date (YYYY-MM-DD)"
},
"countryOfFormation": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Entity formation country"
}
},
"description": "Intermediary beneficiary owner's RFI data"
}
},
"title": "RFI Requirements",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"SOURCE_OF_FUNDS",
"METHOD_OF_VERIFICATION",
"NAME",
"TRADE_NAME",
"NATIONAL_IDENTIFICATION_NUMBER",
"DATE_OF_FORMATION",
"COUNTRY_OF_FORMATION",
"ENTITY_TYPE",
"INDUSTRY_TYPE",
"ADDRESS",
"AUTHORIZED_SIGNATORIES",
"BENEFICIARY_OWNERSHIP"
],
"properties": {
"NAME": {
"type": "string",
"description": "Business legal registered name"
},
"EMAIL": {
"type": "string",
"description": "Business contact email address"
},
"PHONE": {
"type": "string",
"description": "Business contact phone number"
},
"ADDRESS": {
"ref": "#/$defs/address"
},
"WEBSITE": {
"type": "string",
"description": "Business website URL"
},
"TRADE_NAME": {
"type": "string",
"description": "Business trade name or DBA (Doing Business As)"
},
"ENTITY_TYPE": {
"type": "string",
"description": "Business structure type (Corporation, LLC, Partnership, etc.)"
},
"INDUSTRY_TYPE": {
"type": "string",
"description": "Business activity classification"
},
"SOURCE_OF_FUNDS": {
"type": "string",
"description": "Transaction source of funds"
},
"DATE_OF_FORMATION": {
"type": "string",
"format": "date",
"description": "Company formation date (YYYY-MM-DD)"
},
"BENEFICIARY_OWNERS": {
"ref": "#/$defs/beneficiaryOwner"
},
"COUNTRY_OF_FORMATION": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Entity formation country"
},
"BENEFICIARY_OWNERSHIP": {
"type": "boolean",
"description": "Whether any individuals or intermediaries own 25% or more of the company"
},
"AUTHORIZED_SIGNATORIES": {
"ref": "#/$defs/individual"
},
"METHOD_OF_VERIFICATION": {
"type": "string",
"description": "Verification method used"
},
"NATIONAL_IDENTIFICATION_NUMBER": {
"type": "string",
"description": "Business identification number (e.g., Tax ID)"
},
"INTERMEDIARY_BENEFICIARY_OWNERS": {
"ref": "#/$defs/intermediaryBeneficiaryOwner"
}
},
"description": "RFI Data Requirements"
}
},
"fileRequirements": [
"FORMATION_DOCUMENT"
]
}
}Authorizations
Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.
Path Parameters
The payment id created previously. System-generated unique identifier of the resource.
Example:
"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
The RFI id created previously. System-generated unique identifier of the resource.
Example:
"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
Response
The RFI retrieved successfully.
Response schema for Request for Information (RFI) details
Show child attributes
Show child attributes
System-generated unique identifier of the resource.
Example:
"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
System-generated unique identifier of the resource.
Example:
"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
Status of the RFI (Request for Information)
Available options:
INFORMATION_REQUIRED, IN_REVIEW, APPROVED, REJECTED Example:
"APPROVED"
Level of the RFI (Request for Information)
Available options:
LEVEL_1, LEVEL_2, LEVEL_3 Example:
"LEVEL_1"
Date and time when the resource expires
Example:
"2023-01-01T12:04:05Z"
Show child attributes
Show child attributes
System-generated unique identifier of the resource.
Example:
"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
Base64 encoded certificate in PEM format
Example:
"LS0tLS1CRUdJT..."
BFI domain which is available in the CommonName attribute of the cert
Example:
"api.circle.com"
The public key for the BFI defined in RFC 7517
Show child attributes
Show child attributes
The curve used for the EC key
Example:
"P-256"
Key ID
Example:
"263521881931753643998528753619816524468853605762"
Key type
Example:
"EC"
X coordinate for the EC public key
Example:
"KnxBe8fb2mL_Ve9-tqjGSkGgE9f0yohMkAvH_InaFtE"
Y coordinate for the EC public key
Example:
"D41cVUpiKcey4LJKNFtUtmVHDWRmhjZapPLfryX5b1o"
Show child attributes
Show child attributes
Version of the RFI requirement schema provided by CPN.
Example:
1
JSON schema for the RFI requirements. Note that references use 'ref' instead of '$ref' to avoid YAML parsing issues.
Example:
{
"type": "object",
"$defs": {
"address": {
"type": "object",
"required": ["street", "city", "country"],
"properties": {
"city": {
"type": "string",
"description": "City name"
},
"street": {
"type": "string",
"description": "Street address"
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Country code (e.g., US, GB)"
},
"postalCode": {
"type": "string",
"description": "Postal or ZIP code"
},
"stateProvince": {
"type": "string",
"description": "State or province"
}
},
"description": "Full address"
},
"individual": {
"type": "object",
"required": ["name", "address", "dateOfBirth"],
"properties": {
"name": {
"type": "string",
"description": "Individual's full name"
},
"address": { "ref": "#/$defs/address" },
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "Individual's date of birth (YYYY-MM-DD)"
}
},
"description": "Individual's RFI data"
},
"beneficiaryOwner": {
"type": "object",
"required": [
"name",
"address",
"dateOfBirth",
"percentage"
],
"properties": {
"name": {
"type": "string",
"description": "Individual's full name"
},
"address": { "ref": "#/$defs/address" },
"percentage": {
"type": "number",
"description": "Company ownership percentage"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "Individual's date of birth (YYYY-MM-DD)"
}
},
"description": "Beneficiary owner's RFI data"
},
"intermediaryBeneficiaryOwner": {
"type": "object",
"required": [
"name",
"address",
"dateOfFormation",
"countryOfFormation",
"percentage"
],
"properties": {
"name": {
"type": "string",
"description": "Business legal name"
},
"address": { "ref": "#/$defs/address" },
"percentage": {
"type": "number",
"description": "Company ownership percentage"
},
"dateOfFormation": {
"type": "string",
"format": "date",
"description": "Company formation date (YYYY-MM-DD)"
},
"countryOfFormation": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Entity formation country"
}
},
"description": "Intermediary beneficiary owner's RFI data"
}
},
"title": "RFI Requirements",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"SOURCE_OF_FUNDS",
"METHOD_OF_VERIFICATION",
"NAME",
"TRADE_NAME",
"NATIONAL_IDENTIFICATION_NUMBER",
"DATE_OF_FORMATION",
"COUNTRY_OF_FORMATION",
"ENTITY_TYPE",
"INDUSTRY_TYPE",
"ADDRESS",
"AUTHORIZED_SIGNATORIES",
"BENEFICIARY_OWNERSHIP"
],
"properties": {
"NAME": {
"type": "string",
"description": "Business legal registered name"
},
"EMAIL": {
"type": "string",
"description": "Business contact email address"
},
"PHONE": {
"type": "string",
"description": "Business contact phone number"
},
"ADDRESS": { "ref": "#/$defs/address" },
"WEBSITE": {
"type": "string",
"description": "Business website URL"
},
"TRADE_NAME": {
"type": "string",
"description": "Business trade name or DBA (Doing Business As)"
},
"ENTITY_TYPE": {
"type": "string",
"description": "Business structure type (Corporation, LLC, Partnership, etc.)"
},
"INDUSTRY_TYPE": {
"type": "string",
"description": "Business activity classification"
},
"SOURCE_OF_FUNDS": {
"type": "string",
"description": "Transaction source of funds"
},
"DATE_OF_FORMATION": {
"type": "string",
"format": "date",
"description": "Company formation date (YYYY-MM-DD)"
},
"BENEFICIARY_OWNERS": { "ref": "#/$defs/beneficiaryOwner" },
"COUNTRY_OF_FORMATION": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Entity formation country"
},
"BENEFICIARY_OWNERSHIP": {
"type": "boolean",
"description": "Whether any individuals or intermediaries own 25% or more of the company"
},
"AUTHORIZED_SIGNATORIES": { "ref": "#/$defs/individual" },
"METHOD_OF_VERIFICATION": {
"type": "string",
"description": "Verification method used"
},
"NATIONAL_IDENTIFICATION_NUMBER": {
"type": "string",
"description": "Business identification number (e.g., Tax ID)"
},
"INTERMEDIARY_BENEFICIARY_OWNERS": {
"ref": "#/$defs/intermediaryBeneficiaryOwner"
}
},
"description": "RFI Data Requirements"
}File Key for RFI (Request for Information)
Available options:
FORMATION_DOCUMENT, ORG_STRUCTURE, INVOICE, BENEFICIARY_OWNERS_DOCUMENT, ID_DOCUMENT, PROOF_OF_ADDRESS_DOCUMENT, ADDITIONAL_DOCUMENTS Was this page helpful?