Recall Investment

Description

If the investor needs to stop participating in the offering, they can recall the investment while the offering is still active. Recalling requires the following flow:

1. Submit request to recall the investment.

2. Receive acceptance/rejection of that request.

3. Update internal systems.

Endpoints

Task	How	Error Codes
Recall Asset	../asset/{assetId}/recall	AC0001 AC0006 AC0007 AC0009 AC0013 AC0014 AC0016 AC0017 AC0024 AC0029 AC0049 AD0022 AD0023 AS0001 AS0002 AS0003 AS0004 AS0005 AU0001 AU0002 AU0003 CI0001 CI0002 CI0003 CT0017 FL0001 FL0002 FL0003 FL0004 FL0005 FL0006 FL0008 FL0010 FL0011 FL0017 FL0019 FL0020 GN0002 IS0008 IS0009 IS0012 IS0013 IS0016 IS0035 IS0099 IS0106 IV0001 IV0003 IV0006 IV0007 IV0009 IV0013 IV0016 IV0017 IV0018 IV0023 IV0036 QU0001 QU0002 QU0003 QU0004 QU0005 QU0006 QU0007 QU0008 QU0009 QU0010
Get Asset Details	../asset	AU0001 AU0002 GN0002 GN0004 GN0005

Error Codes and Messages

Key Validations

Type	Code	Message
Asset	AS0005	Asset '{assetId}' is in invalid state for the current action. Current status: '{currentState}'. Required status: '{allowedStates}'
Issuance (Security)	IS0012	Security '{securityId}' is in invalid state for the current action. Current status: '{currentState}'. Required status: '{allowedStates}'

Other Business Rule Validations

Type	Code	Message
Account	AC0006	An ABA or SWIFT number is required when providing banking information
	AC0007	Intermediary bank account must be provided for further credit
	AC0013	Account name is mandatory for new accounts
	AC0014	Account type is mandatory for new accounts
	AC0016	Account relationshipType is mandatory for new accounts
	AC0017	Account type cannot be updated for existing accounts
	AC0024	Action is not supported for new account creation. Please use existing account
	AC0029	Updating omnibus account is not allowed for current action.
	AC0049	Cannot set subtype '{subType}' for account type '{type}'. Allowed subtypes are: '{allowed}'
Files	FL0001	The following files could not be found in the correct status: '{fileIds}'
	FL0006	The file correlation ids '{correlationIds}' are already in use
	FL0010	Documents cannot be reused both as investor documents and transaction data documents
	FL0011	Investor documents can only be reused by the investor that owns them
Issuance (Security)	IS0016	Security '{securityId}' is not compatible with asset '{assetId}'
	IS0035	This action is reserved for offerings with security type set to '{allowedTypes}'
	IS0099	You do not have the role for this action on security '{securityId}'. Required roles: '{requiredRoles}'; current roles: '{currentRoles}'
Investor	IV0006	Investor type is mandatory for new investors
	IV0007	Investor name is mandatory for new investors
	IV0009	Investor type cannot be updated for existing investors
	IV0013	Investor can only be updated by the owner organization
	IV0018	Action is not supported for changing the holders list.
	IV0023	Accreditation Other is not available for US investor

Technical Validations

Type	Code	Message
Account	AC0001	Account with Account ID '{accountId}' not found.
	AC0009	The account correlation ids '{correlationIds}' are already in use
Advisor	AD0022	Advisor name is mandatory for new advisors
	AD0023	Advisor type is mandatory for new advisors
Asset	AS0001	The asset id '{assetId}' is invalid
	AS0002	You are trying to access an asset that was never recorded on the ledger due to a failed transaction
	AS0003	Asset id was not provided
	AS0004	Asset '{assetId}' is locked for edit by another process. Please try again later.
Auth (OAuth)	AU0001	The access token is invalid or missing. Please provide a valid access token issued by the OAuth server using the client credentials grant (default location is on the authorization header).
	AU0002	You do not have access to this scope: '{scope}'
	AU0003	The core access token is invalid for organization '{orgId}'.
Contact Info	CI0001	Contact preference type 'other' requires 'additionalTypeInfo' to be provided.
	CI0002	Duplicate contact preference types found: '{duplicateTypes}' for subject: '{subject}'
	CI0003	Duplicate contact preference subject ids found: '{subjectIds}'
Custodian	CT0017	Custodian name is invalid
Files	FL0002	File ID, correlation ID and uploadData are missing from the payload. At least one of them should be provided.
	FL0003	Provided data cannot contain fileId or correlationId and uploadData at the same time.
	FL0004	Found duplicated fileIds '{fileIds}' in multiple files
	FL0005	Found duplicated correlationId '{correlationId}' in multiple files
	FL0008	File with Correlation ID '{correlationId}' not found
	FL0017	Two or more duplicated correlation ids '{orgCorrelationId}' were provided for file
	FL0019	Correlation id '{correlationId}' cannot be provided alongside file id '{fileId}'.
	FL0020	Multiple entries for the same file '{fileId}' detected in the payload.
Generic	GN0002	The payload you have supplied is invalid.
	GN0004	Page size must be an integer between 1 and {maxPageSize}
	GN0005	Offset must be an integer bigger or equal to 0
Issuance (Security)	IS0008	Security id or correlation data was not provided
	IS0009	The security id '{securityId}' is invalid
	IS0013	Security '{securityId}' is restricted
	IS0106	Cannot provide both Security id and correlation data at same time
Investor	IV0001	Investor with Investor ID '{investorId}' not found.
	IV0003	The investor correlation ids '{correlationIds}' are already in use
	IV0016	Duplicated investor ids detected
	IV0017	Duplicated investor correlation ids detected: {duplicateCorrelationIds}
	IV0036	Duplicated form PF data detected for type {type}
Questionnaire	QU0001	You cannot use 'allowedAnswerValues' in a question with the answerType '{currentAnswerType}'. It is only to be used when the answerType is 'Choice'. Questionnaire type: '{questionnaireType}', question text: '{questionText}'.
	QU0002	You cannot provide more than 1 answer in a question with the answerType '{currentAnswerType}'. Questionnaire type: '{questionnaireType}', question text: '{questionText}'.
	QU0003	The answer for the question with answerType '{currentAnswerType}' is expected to have exactly one '{expectedValue}' property. Provided properties: '{provided}'. Questionnaire type: '{questionnaireType}', question text: '{questionText}'.
	QU0004	The choice values '{provided}' is not part of the allowed answer values for question with the questionText: '{questionText}'. Questionnaire type: '{questionnaireType}'.
	QU0005	Duplicate answer ids found for question '{questionText}': '{ids}'. Questionnaire type: '{questionnaireType}'.
	QU0006	Duplicate values found for question '{questionText}': '{answers}'. Questionnaire type: '{questionnaireType}'.
	QU0007	Duplicate questionnaire ids found: '{ids}'.
	QU0008	Duplicate questionnaire types found: '{types}'.
	QU0009	Duplicate question ids found: '{ids}'. Questionnaire type: '{questionnaireType}'.
	QU0010	Duplicate allowed answer values found for question '{questionText}': '{values}'. Questionnaire type: '{questionnaireType}'.