--- title: "Create a Funds Confirmation Consent" method: POST path: "/funds-confirmation-consents" tags: ["Funds Confirmation Consents"] --- # Create a Funds Confirmation Consent `POST /funds-confirmation-consents` Enables a CBPII to ask an ASPSP to create a new funds-confirmation-consent resource, by sending a copy of the consent to the ASPSP. ## Headers - `x-fapi-auth-date` string - `x-fapi-customer-ip-address` string - `x-fapi-interaction-id` string - `Authorization` string, required - `x-customer-user-agent` string - `x-client-id` string ## Request body - OBFundsConfirmationConsent1 - `Data` object, required - `ExpirationDateTime` string, date-time — Specified date and time the funds confirmation authorisation will expire. If this is not populated, the authorisation will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 - `DebtorAccount` object, required — Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied. - `SchemeName` string, required — Name of the identification scheme, in a coded form as published in an external list. For a full list of values see `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `Identification` string, required — Identification assigned by an institution to identify an account. This identification is known by the account owner. - `Name` string — Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. - `SecondaryIdentification` string — This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). - `Proxy` OBProxy1 — Specifies an alternate assumed name for the identification of the account. - `Identification` string, required — Identification used to indicate the account identification under another specified name. - `Code` 'TELE' | 'EMAL' | 'DNAM' | 'CINC' | 'COTX' | 'COID' | 'CUST' | 'DRLC' | 'EIDN' | 'EWAL' | 'PVTX' | 'LEIC' | 'MBNO' | 'NIDN' | 'CCPT' | 'SHID' | 'SOSE' | 'TOKN' | 'UBIL' | 'VIPN' | 'BIID', required — Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values refer to `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `Type` string — Type of the proxy identification. ## Response `201` Funds Confirmation Consent Created - OBFundsConfirmationConsentResponse1 - `Data` object, required - `ConsentId` string, required — Unique identification as assigned to identify the funds confirmation consent resource. - `CreationDateTime` string, date-time, required — Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 - `Status` 'AWAU' | 'RJCT' | 'AUTH' | 'CANC' | 'EXPD', required — Specifies the status of consent resource in code form. For a full list of values refer to `OBInternalConsentStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `StatusReason` OBStatusReason[] - `StatusReasonCode` string — Specifies the status reason in a code form. For a full list of values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `StatusReasonDescription` string — Description supporting the StatusReasonCode. - `Path` string — Optional reference to the JSON Path of the field when status reason refers to an object/field, e.g., Data.DebtorAccount.SchemeName - `StatusUpdateDateTime` string, date-time, required — Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 - `ExpirationDateTime` string, date-time — Specified date and time the funds confirmation authorisation will expire. If this is not populated, the authorisation will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 - `DebtorAccount` object, required — Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied. - `SchemeName` string, required — Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `Identification` string, required — Identification assigned by an institution to identify an account. This identification is known by the account owner. - `Name` string — Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. - `SecondaryIdentification` string — This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). - `Proxy` OBProxy1 — Specifies an alternate assumed name for the identification of the account. - `Identification` string, required — Identification used to indicate the account identification under another specified name. - `Code` 'TELE' | 'EMAL' | 'DNAM' | 'CINC' | 'COTX' | 'COID' | 'CUST' | 'DRLC' | 'EIDN' | 'EWAL' | 'PVTX' | 'LEIC' | 'MBNO' | 'NIDN' | 'CCPT' | 'SHID' | 'SOSE' | 'TOKN' | 'UBIL' | 'VIPN' | 'BIID', required — Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values refer to `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `Type` string — Type of the proxy identification. - `Links` Links — Links relevant to the payload - `Self` string, uri, required - `First` string, uri - `Prev` string, uri - `Next` string, uri - `Last` string, uri - `Meta` Meta — Meta Data relevant to the payload - `TotalPages` integer - `FirstAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 - `LastAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 ## Other responses - `400` — Bad request - `401` — Unauthorized - `403` — Forbidden - `405` — Method Not Allowed - `406` — Not Acceptable - `415` — Unsupported Media Type - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.net/openbankinguk/apis/confirmation-of-funds-api-specification.md) · [All operations](https://skmtc.net/openbankinguk/apis/confirmation-of-funds-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openbankinguk/confirmation-of-funds-api-specification/revisions/b9822eeed1d2/schema)