Skip to main content
POST
/
v1
/
cpn
/
payments
/
{paymentId}
/
rfis
/
{rfiId}
/
submit
Submit RFI data
curl --request POST \
  --url https://api.circle.com/v1/cpn/payments/{paymentId}/rfis/{rfiId}/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rfi": {
    "version": 1,
    "data": "eyJhbGciOiJFQ0RILUVTK0ExMjhLVyIsImVuYyI6IkExMjhHQ00iLCJlcGsiOnsiY3J2IjoiUC0yNTYiLCJrdHkiOiJFQyIsIngiOiI1TEtTbUtsNmVYV0dQNHlGb2tVaks4RGppU0l5YWpQdzJ6UUp1YVhFbEZzIiwieSI6IlRVT29MTV8wc294b0UzYVFmSExlUzRlRkZ3RU9tZ1VDRUh1eDVRMXdVYTQifX0.kVGnfB8eIqxq3bMvhedxUmZvkCrRfQOy.bTUOc_ilvZjb9VYP.pOS6Ul8Jnp_pijWtaQYC0b1NLN1Nc-t_MTsfj5EZy6s62ijQWGtAoo3enwx3gOpXIQDIIF7c-F3KSrVO33a5RIF8a4tvU7pRk_JDKVgHFVpSzvOaUHNHsMUvvctAncx1SneVE_gnm5ATkWO4_1i7irTkb-cjWLmvJ1vVEyJiC9ZgsEdK_eBAewpZTyyKxvoxBpo8IZ3g7qax712TvMsNpIJ_faQmsyRKwt2kBxDPyrWILcIvS1qij6uVOsEP2R6LXbWfBqVbklsgNPWjndXSmOJmsTdBjFzublMLSHmLxkfaD9gt3DxgD16rqDlKO9KmaRF3r322VumP4hrlfOsZUHHcVGeTpgjZwI9jrj76PiYtyCOeR7-kz97PamqrOQAfWRE8Rcp8QdCO6yFHFe3N2pI5kWakH783DVDAsm_x2VY_V8vCDe-xkIoJOabx3LqaxHq8_x_ATXZ01NX-5F9VqgtE73FOIGhinxt8G-Kfxvdlx6gv-QSfBvigVuoR1OCSPNB3OHirEKXY3IjWnjZuENNnXl9CqrCsHQZS1eb1KcaIkg_2NF6gi54htX6ijpUtyXS03IGZW6Bn6CSWqmmvMStIAIYO-8ZJrrleeCfU6WY5KjFlIvN6th-tE41JNJWS9mVqhjzwPC7GQ5bGkqq2zJKhALOuN_0oG4jXOYo1s3YAn-xw3kpq46fYyUrX4nLSocaKDeKOMMqh57_jcMDmHrXdmjlHGPMrBPdU_deub121c3ofTKgJg4KRC8mcTYcXe71uflARAr24msd9A_IPPVbhfvs06HOVKL2-jK6r_WL_9vWU3q-OPQHU3eWUOhI18vZ0CkGqJjtEKyBBmc4inWEbrsO02P2Zd5VTBCIoAaNrpY6n5mNyKPo6-PyrxNy27d6u2yoZvjG6QSuUO9DaX4AyGsE87agh_XgLW9RPXfcZQ7F5aUCQwEA0cF9YSEaYYBGziS7oQ99D1th1MQqEPcFxD5YPdyaPykU3Zbf5T8HSZz1risMbgQu97eXoarxm801pdw5cuKijqj39BVrgdLUfaQ9P-iGWcVJk8ZVXfHK3JHGaBuIjYNIy5lHF3TsKgV2x-wWxqER9vPdgejAGirkxHQaKPt2rg0rmbk3R7YTibT7yTKwO1PRiewi0lxKWvZqDbCoedyuYZCR0vup4S1ZVYX6uGBn-F5ODrnLoAZTbnV1tjDJgxFpA8EKsXWTrc78XH0715lY2OnbDtBOLMbxFJjK1_YDRU2UMkZTEx5BrhR4YibBd4-BCZT-dWTxanOHMxTKl823tyggY5lBQ8DlsLj1qZpOxKWYTM8WrLCZa7vZo9FmXw38FxYrqbwespe7xdS7onfmlI4Ug92eTtZ31FbZfcqOiAGgH9Etkj1M9scP0is6zVC6cIUQzC3NmHNxNtPv6XjMUWigijosvs7x9-qyVCqzJZlEGck2BJ6Uk7ug9QKcxHtaWgtuHPnA77KVE3Vi_dikYaXzxIdgjrGtqqUhXEhrAFkesvJ0UeH1ac94e-R8UrJX75w4DDoRyaFxQhDFdHVtD0ceVN7ekYJkmoS2eSAzWDwsKUvUrmafcfpQ922tZGq0RvnMh39SWy6I6xRFyYHarra24Gbawa5_THjB8TkHJ180giPC3KQAa_6Vz8CP-fks6_-MdGXPW0SYhNghNi_14ZXQ3rZYHaTICgeHhBfhJ4MQ6OlRkiRCrIkM5WSOTS_H715aeyUCL-dlZ0TiG2DpAIXkN1KMRp0jL_W12pg5SjKFAlOGnQgkgj9rO_C7pLxMyIhgEUKPHXMGN6Q7tpVhAAyTl0tabd7cvyWnf5L4UiyIpvb1qrt1bY6-VNA4KXz6Y5uiiBYFF_FIN3K6YZCT4l0zuh_gxmP9eba7zM5kgas1tr1IxYWI-mQiE9Rb8rX0hqXpMj27h9Mf_Sn56TJeEmW8d8x2Xy2Nb7KU9vQO-6uc_taXP0Lv5LFcSwZkdVe7FOeZD-GoaNDly9MdhXI4ELP4MOZXZFJeN7aCJvJeLRBPWnoM2aazDwtlA_KfhZVFtCsKKjJazv6J9h6CDHAm7NuexVJiPdtS1yknQDWrIBfneaLJasmtuhuAbRPtiTvvhQOXt51q0G7sjCSmmeNMwb5fFphe4wLJNmsbdgMFDcUVzb0ImIArCxqBEEK8uuRGcYaRifaLv0zkk29NAT99Ux580zaeN_x7aIMpJTt7jLP0-HZ-QU3MAGg3PLJ3_Oly6ABoULkEkmRhF0TtpU8z-kmmN6FtmzZK74kYEC75smgVTnnJK1kBdsZw9cxHeUx8aDJGrS3OK-uYN0dPJls2LC7X1rHD7ES179nPVBeJA2REm-jSlhVlV_I7JrVzlcXs0Fhx0hX-OgMKz_yQNHnM6RbgGnSLDcvND7vXqkEMgHeDRomhU1hMeu0DymctTKawtzIkV7MYwoibLDUeMvaXN8MicMs64D8I3Ld7BLtFf9o8rMeeNJ0Om7xdl9SGD2RYAep0cxw2rEIIr859e1vutBuvrrMz09dZKd05t1lu0jRztkQzUW9N-VZh9muTAoh_s3NrF2ZTFnRAfzxohwNLxxmX-Ov94FXBhuRHBQXb931I5m2URglrYcoAZ8RFoiAWW2AkHcyb5PRoQIt-LQhOM-bcn1VB44Okh10jqWpGbLno6AvE5FcoRVcspb0tor9EbksW2cipoypcaat5NhQgvo2rAPmkHGi8iB-z_xWORvUkaA2xknNW59myO6qTvjYQ_1P1ESbRO30nUeqgP3VoZrC1-bi9IbgSi-na31xEhdr-ZGuvtRSzyhWwqfviJgSMZ6_kkGW3gUI4ldurTwss6gDHWYmdV-lHtPMfYuD2KMQk1EyJ-3vZx0syLKDACL37HqAYvkW5GiOxrK9cNrSInQ8rZMDkXsaCZMEtvs03Qw2DyCBdoFeXPvFHJ6Vetou-7Oo6rdlmSkt5KdA-w9KKVIAt9WtYxNc-wjFm-vOMcOHb_xxzacDzYFJj8NxdW8GaVdrCvh3j5Yakr_3vSvRM5rpzQKMqw-B53SWV3oOHYu29qso5zSTz-dvAlZUL8Z1a3s13qdwhUkkRexIi6oTU0Da21pT-gCan2jSY_VKR8JdirKTLocn74JZ3InF8iH8XhOD0X7ySIbB69HqMLYRd9r13q2odfJ3cN1CWSF71zgIuZoYSbkO9DeFvCImA-WEIWrP1kJiYlpJi8VnFNQs8XWIxdCydft-8zvoXZbi0MoNt3kJExbKx7dReHx6B-6iwjuW8-o5RbeMvdTIYTp-y6YPsFhcVCvTlS7IefXqG4G3OrnNc5JIVnvdYXWCWUdWguiKdqB6FL_LSWOtsWrB6nIv69WP1WJJSa0Oa_EkxEwXK1BGH9-QpMqkP6rATSvsbaTywfCxqUqm7SzYH81lSCIvI5J7bWX5blk9rNZbp3aSeEpVRm03vwLrgUHLv9vMAopNnw5fZGKfcg3I5ZWYHNQo5BZk9LVpebMBYGijwNDnuFu08eF7ShlEzy50NsvgeDxZtfUVx8cviYn0MoTJBPlz1mXRSIr3zDIpefxDGnsQ1KK8LTi0Gbnt_ybeiT4yTmajrPLE4566D6AQIdDmCg_RsBtB_lAw.S2qu0MNMu2WNiEYoHh25ww"
  }
}'
{
  "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",
      "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

​
Authorization
string
header
required

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

​
paymentId
string<uuid>
required

The payment id created previously.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
rfiId
string<uuid>
required

The RFI id created previously.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

Body

application/json

Request body for submitting encrypted Request for Information (RFI) data

​
rfi
object
required

Response

RFI data submitted successfully

​
data
object
required

Response schema for Request for Information (RFI) details

⌘I