1. Counterparties
getneo
  • Introduction
  • API examples
  • Technical topics
    • API structure
    • HTTP headers
    • Decoupled responses
    • Validation failures (418)
  • Endpoints
    • Auth
      • Get service bearer token (password)
        GET
      • Change tenant
        GET
      • Close session
        GET
    • Counterparties
      • Documents
        • Upload document for a counterparty
        • Retrieve all document info attached to a specific counterparty
      • List counterparties
        GET
      • Get counterparty by ID
        GET
      • Get draft counterparty by ID
        GET
      • Submit counterparty draft
        POST
      • Update counterparty draft
        POST
      • Delete a counterparty draft
        DELETE
      • Add account to counterparty
        POST
      • Update counterparty account
        PATCH
      • Export counterparty data
        POST
      • Verify payee details
        POST
    • MSB
      • List subclients
      • Get a subclient by ID
      • Create a new subclient
      • Update a subclient
    • Payments
      • Documents
        • Upload document for a payment
        • Retrieve all document info attached to a specific payment
      • List payments
        GET
      • Get a payment by ID
        GET
      • Make a payment (deposit, withdrawal or internal)
        POST
    • Trading
      • Subscribe to quotes
      • Quote order
      • Submit order
    • Wallets
      • List wallets
      • Get a wallet by ID
  • Schemas
    • Reference
      • actions
      • bic_swift
      • country
      • currency
      • entity_key
    • Enums
      • OrderTypes
    • Subclients
      • subclientAddressesModel
      • subclientDetailsModel
      • subclientParentModel
      • subclientAdditionalInformationModel
      • subclientResponseModel
      • subclientRequestModel
      • subclientRegulatorsModel
      • subclientInternalInformationModel
      • subclientRegulatorModel
      • subclientKycModel
      • subclientKycDetailsModel
    • Components
      • AmountModel
      • AmountModelWithRate
      • BaseableAmountModel
      • CorpModel
      • IbanModel
      • TenantInfo
      • WalletModel
      • WalletLedgerModelV5
      • OrderLegAccount
      • PersonModel
    • Response
      • standard-Validation-Failure
    • Payments
      • VoP
        • VopResponseModel
        • VopRequestModel
        • VopForm
      • PaymentForm
      • paymentSourceForm
      • addressModel
      • paymentUpdateForm
    • Responses
      • CorpWalletModelV2
      • FullIdentityResponse
      • IdentityResponse
    • Schemas
    • Trading
      • OrderQuoteForm
    • Documents
    • corpExternalBicModel
    • corpModel
    • corpTagModel
    • ibanModel
    • idDocModel
    • identityModel
    • identityModel-2
    • idServiceModel
    • inviteAcceptForm
    • inviteModel
    • loginFormModel
    • passwordChangeForm
    • passwordResetForm
    • passwordResetRequestForm
    • passwordValidation
    • permissionModel
    • positionsModel
    • roleModel
    • rolesModel
    • statusCodeResult
    • sumsubReviewResultModel
    • sumsubWebhookPayloadModel
    • twofaChallengeStatusModel
    • twoFactorMethod
    • twoFactorMethodForm
    • twoFactorResponseForm
    • twoFactorVerifyModel
    • userCorpModel
    • userCreateForm
    • userEditForm
    • userIdentityDocumentModel
    • userIssueReport
    • userModel
    • userPermissionsModel
    • usersModel
    • validationRule
    • accountInfo
    • accountOwnerModel
    • accountSlim
    • amountModel
    • amountModelWithRate
    • amountSlim
    • baseableAmountModel
    • blotterOptionsBatchModel
    • blotterOptionsModel
    • clientCorpAddressModel
    • commissionChange
    • commissionResponseModel
    • commissionResponseModel-2
    • confirmationDocumentResponseModel
    • contextualIbanModel
    • corpFeesModel
    • corpIdentificationModel
    • corpProfileModel
    • counterpartyAccountControlModel
    • counterpartyAccountModelV2
    • counterpartyAccountOnEntityModelV3
    • counterpartyAddressModel
    • counterpartyModelV2
    • counterpartyOnEntityModelV3
    • counterpartyParentModel
    • currentAccountControlValues
    • currentAccountValuesExtended
    • currentCounterpartyValuesExtended
    • forwardRateModel
    • ibanSlim
    • intermediaryBankAccountModel
    • invoiceableAmountModel
    • leg
    • leg-2
    • leg-3
    • legacyAddressModel
    • marginResponseModel
    • marginResponseModel-2
    • marketInfoResponseModel
    • marketInfoResponseModel-2
    • markToMarketResponseModel
    • markToMarketResponseModel-2
    • orderBookingRequestModel
    • orderPaymentRequestModel
    • orderPaymentResponseModel
    • orderPaymentResponseModel-2
    • orderQuoteForm
    • orderQuoteResponse
    • orderQuoteResponse-2
    • orderRejectForm
    • orderSettlementRequestModel
    • orderSettlementResponseModel
    • orderSettlementResponseModel-2
    • paymentAccountModel
    • paymentAttachmentsResponseModel
    • paymentBlotterItemModelV2
    • paymentCounterpartyAccountModel
    • paymentCounterpartyModel
    • paymentDestinationModel
    • paymentFeesChargeModel
    • paymentFeeSlim
    • paymentFeesModel
    • paymentFeesRequestModel
    • paymentForm
    • paymentItemListModel
    • paymentItemSlimModel
    • paymentListApprovalResponse
    • paymentReferenceModel
    • paymentSouceForm
    • paymentSourceModel
    • paymentTrackingSource
    • paymentVopResponseModel
    • personModel
    • quotePriceModel
    • quotePriceModel-2
    • rateModel
    • rejectForm
    • reversableRateModel
    • settlementInstructionsModel
    • specifiedPaymentFee
    • subscriptionFeesModel
    • swapInfoModel
    • swapInfoModel-2
    • tickPriceModel
    • tickPriceModel-2
    • tickRateModel
    • tradeLimitsModel
    • tradeLimitsModel-2
    • tradingFeesModel
    • ultimateSourceModel
    • vopForm
    • walletModel
    • accountModel
    • chargesInfoModel
    • clientCorpModelV1
    • clientCorpModelV3
    • commissionDetailModel
    • corpAdditionalInformationModel
    • corpAddressesModel
    • corpContractModel
    • corpContractsModel
    • corpDetailsModel
    • corpInternalInformationModel
    • corpIntroducerModel
    • corpKycModel
    • corpLegacyAddressesModel
    • corpLeiModel
    • corpReconciliationModel
    • corpRef
    • corpRegulatorModel
    • corpRegulatorsModel
    • corpWalletModel
    • derivedAccountModel
    • derivedFieldModel
    • document
    • documentModel
    • documentVisibility
    • docVisibility
    • editableVisibility
    • executeResult
    • ledgerOperationAccountModel
    • ledgerOperationCorpModel
    • ledgerOperationModel
    • lEIModel
    • linkedRecordModel
    • marginDetailModel
    • matchedModel
    • minimumCommissionModel
    • mtfRecordApprovalForm
    • mtfRecordDefaultValues
    • mtfRecordModelV4
    • mtfRequirementModel
    • mtfValidationForm
    • namedEntityModel
    • operationModel
    • orderKeyListModel
    • orderModel
    • orderPayment
    • overriddenByModel
    • paymentKeyListModel
    • productStatusModel
    • reconcileFromWalletRequest
    • reconcileLedgerTransactionMatchRequest
    • reconcileUnexpectedCreditRequest
    • regReportModel
    • settlementBatchModelV4
    • settlementBatchModelV5
    • settlementCurrencyModel
    • systemStateModel
    • transaction
    • transactionInfoModelV4
    • walletIbanModel1__CorpWalletModel
    • accountLedgerItemModel
    • accountModel-2
    • accountNetworks
    • approvePreviewLogoForm
    • approvePreviewLogoForm-2
    • archiveReasonModel
    • contactModel
    • corpFrameworkAgreementModel
    • corpIbanModel
    • corpMarginDetailModel
    • corpMarginDetailModel-2
    • corpStateModel
    • corpTag
    • corpWalletModelV2
    • counterpartyAccountModelV3
    • counterpartyAttachmentsResponseModel
    • counterpartyModelV3
    • countryIdentityDocument
    • countryModel
    • createCorpWalletForm
    • currencyModel
    • currentAccountValues
    • currentCounterpartyValues
    • detailsModel
    • detailsModel-2
    • documentArchiveModel
    • editNoteModel
    • externalAccountModel
    • externalAccountUpdateForm
    • ibanCountryDetailModel
    • ibanDefinitionModel
    • ibanLookupForm
    • ibanLookupResult
    • intermediaryBankAccountModel-2
    • latestModificationModel
    • marginLineModel
    • networkAvailability
    • noteModel
    • notificationListModel
    • notificationModel
    • orderInfoV2
    • ownerModel
    • priceAlertModel
    • rejectReasonModel
    • reviewerUserModel
    • reviewInfoModel
    • subClientAdditonalAdditionalInformationModel
    • subClientAdditonalAdditionalInformationModel-2
    • subClientAddressesModel
    • subClientAddressesModel-2
    • subClientCorpModel
    • subClientDetailsModel
    • subClientDetailsModel-2
    • subClientInternalInformationModel
    • subClientInternalInformationModel-2
    • subClientKycModel
    • subClientKycModel-2
    • subClientParentModel
    • subClientParentModel-2
    • subClientRegulatorModel
    • subClientRegulatorModel-2
    • subClientRegulatorsModel
    • subClientRegulatorsModel-2
    • subClientRequestModel
    • subClientResponseModel
    • subClientReviewRequestModel
    • suspendReasonModel
    • symbolModel
    • tempPaymentBlotterItemModelV2
    • totalModel
    • vopRequestModel
    • vopResponseModel
    • walletIbanModel1__CorpWalletModelV2
    • walletLedgerCounterpartyModel
    • walletLedgerLimitedCounterparty
    • walletLedgerModelV5
    • symbolTenor
    • uploadRestrictionReferenceModel
  1. Counterparties

Submit counterparty draft

Demo
https://api.demo.getneo.com
Demo
https://api.demo.getneo.com
POST
/v3/counterparties/draft
Save a new counterparty as a draft, to allow for further changes later.

Request

Query Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
OK
Bodyapplication/json

🟠401Unauthorized
🟠403Forbidden
🟠418Validation Failure
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.demo.getneo.com/v3/counterparties/draft?validate=undefined' \
--header 'Content-Type: application/json' \
--data '{
    "accounts": [
        {
            "accountNumber": "string",
            "actions": [
                "string"
            ],
            "additionalCountryAccountInfo": "string",
            "alias": "string",
            "bank": "string",
            "bankAccountId": "string",
            "bankCode": "string",
            "bic_swift": "string",
            "cnaps": "string",
            "controls": {
                "corpRelationship": "sameEntity",
                "immediateIntraCorp": true
            },
            "country": "string",
            "currencies": [
                "string"
            ],
            "iban": "string",
            "intermediaryBank": "string",
            "intermediaryBankAccounts": [
                {
                    "bicSwift": "string",
                    "currency": "string"
                }
            ],
            "isBeneficiary": true,
            "isPayer": true,
            "networks": {
                "neo": {
                    "enabled": true,
                    "reason": "string"
                },
                "sepa": {
                    "enabled": true,
                    "reason": "string"
                },
                "swift": {
                    "enabled": true,
                    "reason": "string"
                }
            },
            "operatorInfo": "string",
            "parentId": "string",
            "recurringReference": "string",
            "routingNumber": "string",
            "sortCodeUK": "string",
            "verificationResponses": [
                {
                    "expireTime": "2019-08-24T14:15:22.123Z",
                    "purpose": "sepaPayee",
                    "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
                    "responseState": "match",
                    "suggestedName": "string",
                    "timestamp": "2019-08-24T14:15:22.123Z"
                }
            ]
        }
    ],
    "actions": [
        "string"
    ],
    "address": {
        "buildingName": "string",
        "buildingNumber": "string",
        "country": "string",
        "countrySubdivision": "string",
        "department": "string",
        "district": "string",
        "floor": "string",
        "postBox": "string",
        "postCode": "string",
        "room": "string",
        "streetName": "string",
        "subDepartment": "string",
        "town": "string",
        "townLocation": "string"
    },
    "address1": "string",
    "address2": "string",
    "alias": "string",
    "city": "string",
    "country": "string",
    "county": "string",
    "currencies": [
        "string"
    ],
    "draft": {},
    "email": "string",
    "firstName": "string",
    "id": "string",
    "isBeneficiary": true,
    "isPayer": true,
    "isSelf": true,
    "lastName": "string",
    "linkedDocuments": {
        "count": 0,
        "uri": "string"
    },
    "name": "string",
    "parent": {
        "alias": "string",
        "displayName": "string",
        "id": "string",
        "isSelf": true,
        "name": "string",
        "state": "incomplete",
        "vanityId": "string"
    },
    "payable": {
        "enabled": true,
        "reason": "string"
    },
    "paymentReason": [
        "string"
    ],
    "postCode": "string",
    "primaryType": "string",
    "shortfall": 0,
    "shortfallCurrencyCode": "string",
    "state": "draft",
    "status": "draft",
    "subsidiary": "string",
    "subType": "string",
    "thirdPartyType": "string",
    "thirdPartyTypeOther": "string",
    "vanityId": "string"
}'
Response Response Example
200 - Example 1
{
    "accounts": [
        {
            "accountNumber": "string",
            "actions": [
                "string"
            ],
            "additionalCountryAccountInfo": "string",
            "alias": "string",
            "bank": "string",
            "bankAccountId": "string",
            "bankCode": "string",
            "bic_swift": "string",
            "cnaps": "string",
            "controls": {
                "corpRelationship": "sameEntity",
                "immediateIntraCorp": true
            },
            "country": "string",
            "currencies": [
                "string"
            ],
            "iban": "string",
            "intermediaryBank": "string",
            "intermediaryBankAccounts": [
                {
                    "bicSwift": "string",
                    "currency": "string"
                }
            ],
            "isBeneficiary": true,
            "isPayer": true,
            "networks": {
                "neo": {
                    "enabled": true,
                    "reason": "string"
                },
                "sepa": {
                    "enabled": true,
                    "reason": "string"
                },
                "swift": {
                    "enabled": true,
                    "reason": "string"
                }
            },
            "operatorInfo": "string",
            "parentId": "string",
            "recurringReference": "string",
            "routingNumber": "string",
            "sortCodeUK": "string",
            "verificationResponses": [
                {
                    "expireTime": "2019-08-24T14:15:22.123Z",
                    "purpose": "sepaPayee",
                    "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
                    "responseState": "match",
                    "suggestedName": "string",
                    "timestamp": "2019-08-24T14:15:22.123Z"
                }
            ]
        }
    ],
    "actions": [
        "string"
    ],
    "address": {
        "buildingName": "string",
        "buildingNumber": "string",
        "country": "string",
        "countrySubdivision": "string",
        "department": "string",
        "district": "string",
        "floor": "string",
        "postBox": "string",
        "postCode": "string",
        "room": "string",
        "streetName": "string",
        "subDepartment": "string",
        "town": "string",
        "townLocation": "string"
    },
    "address1": "string",
    "address2": "string",
    "alias": "string",
    "city": "string",
    "country": "string",
    "county": "string",
    "currencies": [
        "string"
    ],
    "draft": {},
    "email": "string",
    "firstName": "string",
    "id": "string",
    "isBeneficiary": true,
    "isPayer": true,
    "isSelf": true,
    "lastName": "string",
    "linkedDocuments": {
        "count": 0,
        "uri": "string"
    },
    "name": "string",
    "parent": {
        "alias": "string",
        "displayName": "string",
        "id": "string",
        "isSelf": true,
        "name": "string",
        "state": "incomplete",
        "vanityId": "string"
    },
    "payable": {
        "enabled": true,
        "reason": "string"
    },
    "paymentReason": [
        "string"
    ],
    "postCode": "string",
    "primaryType": "string",
    "shortfall": 0,
    "shortfallCurrencyCode": "string",
    "state": "draft",
    "status": "draft",
    "subsidiary": "string",
    "subType": "string",
    "thirdPartyType": "string",
    "thirdPartyTypeOther": "string",
    "vanityId": "string"
}
Modified at 2025-11-28 09:18:39
Previous
Get draft counterparty by ID
Next
Update counterparty draft
Built with