--- title: "Reject transfer" method: POST path: "/tx/reject" tags: ["Transactions"] --- # Reject transfer `POST /tx/reject` Rejects a transfer indicating that the blockchain address is not owned by the beneficiary VASP. Rejecting sets the transfer status to `REJECTED`. ## Request body - TransactionRejectRequest - `id` string, uuid, required — Identifier of the Transfer - `reason` string — Reject reason ## Response `200` Transfer Rejected - Transaction - `id` string, uuid, required — Identifier of the Transfer - `status` 'SAVED' | 'MISSING_BENEFICIARY_DATA' | 'NEW' | 'WAITING_FOR_INFORMATION' | 'SENT' | 'REJECTED' | 'DECLINED' | 'ACK' | 'CANCELLED' | 'INCOMPLETE' | 'ACCEPTED' | 'NOT_READY' — Status of the Transfer * `SAVED` Transfer stored. * `MISSING_BENEFICIARY_DATA` TravelRule: Transfer Information is missing beneficiary data. * `NEW` TravelRule: Transfer Information was created, but not sent yet. * `WAITING_FOR_INFORMATION` TravelRule: Transfer Information is waiting for information to send. * `SENT` TravelRule: Transfer Information was sent (TRLight/TRP) * `REJECTED` TravelRule: Transfer rejected (TRP/Sygna) * `DECLINED` TravelRule: Transfer declined (TRP/Sygna) * `ACK` TravelRule: Destination blockchain address belongs to beneficiary confirmed. * `CANCELLED` Transfer cancelled. * `INCOMPLETE` Transfer created only with Blockchain Data (called by Beneficiary). * `ACCEPTED` Transfer accepted. * `NOT_READY` Transfer not ready. - `transactionType` 'BELOW_THRESHOLD' | 'NON_CUSTODIAL' | 'TRAVELRULE' | 'UNKNOWN', required — Type of the Transfer * `BELOW_THRESHOLD` Transfer is below all threshold. * `NON_CUSTODIAL` Transfer is on a customer owned wallet. Proof required. * `TRAVELRULE` Transfer is between VASPs. TravelRule transfer created. * `UNKNOWN` Transfer with any missing information. - `transactionAsset` string, required — Asset symbol (BTC,ETH) - `transactionAmount` string, required — Amount in base unit of the asset (satoshi, wei, etc) - `chargedQuantity` number, required — Charged Quantity - `amountInLocalCurrency` object — Amount in the local currency of the originator VASP's jurisdiction - `amountInLocalCurrency` number — Amount in the local currency of the originator VASP's jurisdiction - `currency` string — Currency code - `beneficiaryAmountInLocalCurrency` object — Amount in the local currency of the beneficiary VASP's jurisdiction - `amountInLocalCurrency` number — Amount in the local currency of the beneficiary VASP's jurisdiction - `currency` string — Currency code - `originatorDid` string — Decentralized Identifier - `beneficiaryDid` string, required — Decentralized Identifier - `originatorVASPdid` string — Decentralized Identifier - `beneficiaryVASPdid` string — Decentralized Identifier - `transactionBlockchainInfo` TransactionBlockchainInfo — Information about the transaction on the blockchain - `txHash` string — Transaction txHash - `origin` string — Originator Address - `destination` string, required — Destination Address - `ivms101` Ivms101IVMS101 - `originator` Ivms101Originator — The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer. - `originatorPersons` Ivms101Person[], required — the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer. - `naturalPerson` NaturalPerson - `name` NaturalPersonName[], required — the distinct words used as identification for an individual - `nameIdentifier` NaturalPersonNameID[], required — full name separated into primary and secondary identifier. - … - `localNameIdentifier` LocalNaturalPersonNameID[] — full name separated into primary and secondary identifier using local characters. - … - `phoneticNameIdentifier` LocalNaturalPersonNameID[] — Alternate representation of a name that corresponds to the manner the name is pronounced. - … - `geographicAddress` Ivms101Address[] — the particulars of a location at which a person may be communicated with. - `addressType` 'HOME' | 'BIZZ' | 'GEOG' — Identifies the nature of the address. * `HOME` Residential - Address is the home address. * `BIZZ` Business - Address is the business address. * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person. - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `nationalIdentification` NationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC', required — Identifies the national identification type. * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals. * `CCPT` Passport number - Number assigned by a passport authority. * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority. * `DRLC` Driver license number - Number assigned to a driver's license. * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number). * `TXID` Tax identification number - Number assigned by a tax authority to an entity. * `SOCS` Social security number - Number assigned by a social security agency. * `IDCD` Identity card number - Number assigned by a national authority to an identity card. * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 . * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine. - `countryOfIssue` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `registrationAuthority` string — A character string - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` DateAndPlaceOfBirth - `dateOfBirth` string, required — A point in time, represented as a day within the calendar year. Compliant with ISO 8601. (YYYY-MM-DD) - `placeOfBirth` string, required — A character string - `countryOfResidence` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `legalPerson` LegalPerson - `name` LegalPersonName, required - `nameIdentifier` LegalPersonNameID[], required — The name and type of name by which the legal person is known. - … - `localNameIdentifier` LocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `phoneticNameIdentifier` LocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `geographicAddress` Ivms101Address[] - `addressType` 'HOME' | 'BIZZ' | 'GEOG' — Identifies the nature of the address. * `HOME` Residential - Address is the home address. * `BIZZ` Business - Address is the business address. * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person. - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `customerNumber` string — A character string - `nationalIdentification` NationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC', required — Identifies the national identification type. * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals. * `CCPT` Passport number - Number assigned by a passport authority. * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority. * `DRLC` Driver license number - Number assigned to a driver's license. * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number). * `TXID` Tax identification number - Number assigned by a tax authority to an entity. * `SOCS` Social security number - Number assigned by a social security agency. * `IDCD` Identity card number - Number assigned by a national authority to an identity card. * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 . * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine. - `countryOfIssue` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `registrationAuthority` string — A character string - `dateOfRegistration` string — A point in time, represented as a day within the calendar year. Compliant with ISO 8601. (YYYY-MM-DD) - `countryOfRegistration` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `accountNumber` Text[] — Identifier of an account that is used to process the transfer. The value for this element is case-sensitive. - `beneficiary` Ivms101Beneficiary — The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer. - `beneficiaryPersons` Ivms101Person[], required — the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer. - `naturalPerson` NaturalPerson - `name` NaturalPersonName[], required — the distinct words used as identification for an individual - `nameIdentifier` NaturalPersonNameID[], required — full name separated into primary and secondary identifier. - … - `localNameIdentifier` LocalNaturalPersonNameID[] — full name separated into primary and secondary identifier using local characters. - … - `phoneticNameIdentifier` LocalNaturalPersonNameID[] — Alternate representation of a name that corresponds to the manner the name is pronounced. - … - `geographicAddress` Ivms101Address[] — the particulars of a location at which a person may be communicated with. - `addressType` 'HOME' | 'BIZZ' | 'GEOG' — Identifies the nature of the address. * `HOME` Residential - Address is the home address. * `BIZZ` Business - Address is the business address. * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person. - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `nationalIdentification` NationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC', required — Identifies the national identification type. * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals. * `CCPT` Passport number - Number assigned by a passport authority. * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority. * `DRLC` Driver license number - Number assigned to a driver's license. * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number). * `TXID` Tax identification number - Number assigned by a tax authority to an entity. * `SOCS` Social security number - Number assigned by a social security agency. * `IDCD` Identity card number - Number assigned by a national authority to an identity card. * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 . * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine. - `countryOfIssue` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `registrationAuthority` string — A character string - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` DateAndPlaceOfBirth - `dateOfBirth` string, required — A point in time, represented as a day within the calendar year. Compliant with ISO 8601. (YYYY-MM-DD) - `placeOfBirth` string, required — A character string - `countryOfResidence` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `legalPerson` LegalPerson - `name` LegalPersonName, required - `nameIdentifier` LegalPersonNameID[], required — The name and type of name by which the legal person is known. - … - `localNameIdentifier` LocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `phoneticNameIdentifier` LocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `geographicAddress` Ivms101Address[] - `addressType` 'HOME' | 'BIZZ' | 'GEOG' — Identifies the nature of the address. * `HOME` Residential - Address is the home address. * `BIZZ` Business - Address is the business address. * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person. - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `customerNumber` string — A character string - `nationalIdentification` NationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC', required — Identifies the national identification type. * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals. * `CCPT` Passport number - Number assigned by a passport authority. * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority. * `DRLC` Driver license number - Number assigned to a driver's license. * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number). * `TXID` Tax identification number - Number assigned by a tax authority to an entity. * `SOCS` Social security number - Number assigned by a social security agency. * `IDCD` Identity card number - Number assigned by a national authority to an identity card. * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 . * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine. - `countryOfIssue` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `registrationAuthority` string — A character string - `dateOfRegistration` string — A point in time, represented as a day within the calendar year. Compliant with ISO 8601. (YYYY-MM-DD) - `countryOfRegistration` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `accountNumber` Text[] — Identifier of an account that is used to process the transfer. The value for this element is case-sensitive. - `originatingVASP` OriginatingVASP — The originating VASP is defined in Section 1.1 as the VASP which initiates the VA transfer, and transfers the VA upon receiving the request for a VA transfer on behalf of the originator. - `originatingVASP` Ivms101Person - `naturalPerson` NaturalPerson - `name` NaturalPersonName[], required — the distinct words used as identification for an individual - `nameIdentifier` NaturalPersonNameID[], required — full name separated into primary and secondary identifier. - … - `localNameIdentifier` LocalNaturalPersonNameID[] — full name separated into primary and secondary identifier using local characters. - … - `phoneticNameIdentifier` LocalNaturalPersonNameID[] — Alternate representation of a name that corresponds to the manner the name is pronounced. - … - `geographicAddress` Ivms101Address[] — the particulars of a location at which a person may be communicated with. - `addressType` 'HOME' | 'BIZZ' | 'GEOG' — Identifies the nature of the address. * `HOME` Residential - Address is the home address. * `BIZZ` Business - Address is the business address. * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person. - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `nationalIdentification` NationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC', required — Identifies the national identification type. * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals. * `CCPT` Passport number - Number assigned by a passport authority. * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority. * `DRLC` Driver license number - Number assigned to a driver's license. * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number). * `TXID` Tax identification number - Number assigned by a tax authority to an entity. * `SOCS` Social security number - Number assigned by a social security agency. * `IDCD` Identity card number - Number assigned by a national authority to an identity card. * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 . * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine. - `countryOfIssue` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `registrationAuthority` string — A character string - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` DateAndPlaceOfBirth - `dateOfBirth` string, required — A point in time, represented as a day within the calendar year. Compliant with ISO 8601. (YYYY-MM-DD) - `placeOfBirth` string, required — A character string - `countryOfResidence` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `legalPerson` LegalPerson - `name` LegalPersonName, required - `nameIdentifier` LegalPersonNameID[], required — The name and type of name by which the legal person is known. - … - `localNameIdentifier` LocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `phoneticNameIdentifier` LocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `geographicAddress` Ivms101Address[] - `addressType` 'HOME' | 'BIZZ' | 'GEOG' — Identifies the nature of the address. * `HOME` Residential - Address is the home address. * `BIZZ` Business - Address is the business address. * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person. - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `customerNumber` string — A character string - `nationalIdentification` NationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC', required — Identifies the national identification type. * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals. * `CCPT` Passport number - Number assigned by a passport authority. * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority. * `DRLC` Driver license number - Number assigned to a driver's license. * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number). * `TXID` Tax identification number - Number assigned by a tax authority to an entity. * `SOCS` Social security number - Number assigned by a social security agency. * `IDCD` Identity card number - Number assigned by a national authority to an identity card. * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 . * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine. - `countryOfIssue` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `registrationAuthority` string — A character string - `dateOfRegistration` string — A point in time, represented as a day within the calendar year. Compliant with ISO 8601. (YYYY-MM-DD) - `countryOfRegistration` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `beneficiaryVASP` BeneficiaryVASP — The beneficiary is defined in Section 1.1 as the VASP which receives the transfer of a virtual asset from the originating VASP directly or through an intermediary VASP and makes the funds available to the beneficiary. - `beneficiaryVASP` Ivms101Person - `naturalPerson` NaturalPerson - `name` NaturalPersonName[], required — the distinct words used as identification for an individual - `nameIdentifier` NaturalPersonNameID[], required — full name separated into primary and secondary identifier. - … - `localNameIdentifier` LocalNaturalPersonNameID[] — full name separated into primary and secondary identifier using local characters. - … - `phoneticNameIdentifier` LocalNaturalPersonNameID[] — Alternate representation of a name that corresponds to the manner the name is pronounced. - … - `geographicAddress` Ivms101Address[] — the particulars of a location at which a person may be communicated with. - `addressType` 'HOME' | 'BIZZ' | 'GEOG' — Identifies the nature of the address. * `HOME` Residential - Address is the home address. * `BIZZ` Business - Address is the business address. * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person. - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `nationalIdentification` NationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC', required — Identifies the national identification type. * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals. * `CCPT` Passport number - Number assigned by a passport authority. * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority. * `DRLC` Driver license number - Number assigned to a driver's license. * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number). * `TXID` Tax identification number - Number assigned by a tax authority to an entity. * `SOCS` Social security number - Number assigned by a social security agency. * `IDCD` Identity card number - Number assigned by a national authority to an identity card. * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 . * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine. - `countryOfIssue` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `registrationAuthority` string — A character string - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` DateAndPlaceOfBirth - `dateOfBirth` string, required — A point in time, represented as a day within the calendar year. Compliant with ISO 8601. (YYYY-MM-DD) - `placeOfBirth` string, required — A character string - `countryOfResidence` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `legalPerson` LegalPerson - `name` LegalPersonName, required - `nameIdentifier` LegalPersonNameID[], required — The name and type of name by which the legal person is known. - … - `localNameIdentifier` LocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `phoneticNameIdentifier` LocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `geographicAddress` Ivms101Address[] - `addressType` 'HOME' | 'BIZZ' | 'GEOG' — Identifies the nature of the address. * `HOME` Residential - Address is the home address. * `BIZZ` Business - Address is the business address. * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person. - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `customerNumber` string — A character string - `nationalIdentification` NationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC', required — Identifies the national identification type. * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals. * `CCPT` Passport number - Number assigned by a passport authority. * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority. * `DRLC` Driver license number - Number assigned to a driver's license. * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number). * `TXID` Tax identification number - Number assigned by a tax authority to an entity. * `SOCS` Social security number - Number assigned by a social security agency. * `IDCD` Identity card number - Number assigned by a national authority to an identity card. * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 . * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine. - `countryOfIssue` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `registrationAuthority` string — A character string - `dateOfRegistration` string — A point in time, represented as a day within the calendar year. Compliant with ISO 8601. (YYYY-MM-DD) - `countryOfRegistration` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `transferPath` TransferPath — The transfer path refers to the intermediary VASP(s) participating in a serial chain that receive(s) and retransmit(s) a VA transfer on behalf of the originating VASP and the beneficiary VASP, or another intermediary VASP, together with their corresponding sequence number. - `transferPath` IntermediaryVASP[] — the intermediary VASP(s) participating in a serial chain that receive and retransmit a VA transfer on behalf of the originating VASP and the beneficiary VASP, or another intermediary VASP, together with their corresponding sequence number. - `intermediaryVASP` Ivms101Person, required - `naturalPerson` NaturalPerson - `name` NaturalPersonName[], required — the distinct words used as identification for an individual - … - `geographicAddress` Ivms101Address[] — the particulars of a location at which a person may be communicated with. - … - `nationalIdentification` NationalIdentification - … - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` DateAndPlaceOfBirth - … - `countryOfResidence` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `legalPerson` LegalPerson - `name` LegalPersonName, required - … - `geographicAddress` Ivms101Address[] - … - `customerNumber` string — A character string - `nationalIdentification` NationalIdentification - … - `dateOfRegistration` string — A point in time, represented as a day within the calendar year. Compliant with ISO 8601. (YYYY-MM-DD) - `countryOfRegistration` string — two alphabetic characters representing an ISO-3166 Alpha-2 country, including the code ‘XX’ to represent ‘an indicator for unknown States, other entities or organisations - `sequence` integer, required — Number represented as an integer (18 digits) - `payloadMetadata` PayloadMetadata — Data describing the contents of the payload. - `transliterationMethod` TransliterationMethodCode[] — the method used to map from a national system of writing to Latin script. - `ivms101Encrypted` string — Encrypted IVMS101 data - `protocol` 'TRLight' | 'TRP' | 'OpenVASP' - `protocolData` ProtocolData - `trLightData` object — TRLight Procotol data - `notificationEmails` string[] — Notification emails - `originatorProof` union — Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof - object — Attestation and its corresponding signed proof. - `type` 'eip-191' | 'eip-712' | 'bip-137', required — Type identifier for CryptographicalProof - `proof` string, required — Proof - `attestation` string, required — Attestation - `address` string — blockchain address - `status` string — Status of the proof - object — Screenshot Proof - `type` 'screenshot', required — Type identifier for ScreenshotProof, should be "screenshot" - `url` string, required — URL with the screenshot resource - object — Information about the self-declared proof. - `type` 'self-declaration', required — Type identifier for SelfDeclarationProof (should be self-declaration) - `did` string — customer identifier - `address` string — blockchain address - `attestation` string, required — The attestation - `confirmed` boolean — Whether the proof has been confirmed - `status` string — Status of the proof attestation - object — Information about the micro-transfer proof. - `type` 'microtransfer', required — Type identifier for MicroTransferProof (should be micro-transfer) - `did` string — did - `address` string — blockchain address being validated - `proof` string, required — hash of the micro-transfer proof - `chain` string — The chain of the micro-transfer, in CAIP format - `destination` string — Destination blockchain address - `amountSubunits` string — Amount of the microtransfer - `status` string — Status of the proof attestation - object — Other Proof - `type` string, required - `beneficiaryProof` union — Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof - object — Attestation and its corresponding signed proof. - `type` 'eip-191' | 'eip-712' | 'bip-137', required — Type identifier for CryptographicalProof - `proof` string, required — Proof - `attestation` string, required — Attestation - `address` string — blockchain address - `status` string — Status of the proof - object — Screenshot Proof - `type` 'screenshot', required — Type identifier for ScreenshotProof, should be "screenshot" - `url` string, required — URL with the screenshot resource - object — Information about the self-declared proof. - `type` 'self-declaration', required — Type identifier for SelfDeclarationProof (should be self-declaration) - `did` string — customer identifier - `address` string — blockchain address - `attestation` string, required — The attestation - `confirmed` boolean — Whether the proof has been confirmed - `status` string — Status of the proof attestation - object — Information about the micro-transfer proof. - `type` 'microtransfer', required — Type identifier for MicroTransferProof (should be micro-transfer) - `did` string — did - `address` string — blockchain address being validated - `proof` string, required — hash of the micro-transfer proof - `chain` string — The chain of the micro-transfer, in CAIP format - `destination` string — Destination blockchain address - `amountSubunits` string — Amount of the microtransfer - `status` string — Status of the proof attestation - object — Other Proof - `type` string, required - `actions` TransactionAction[] - `hash` string — Credential Hash - `issuerDID` string — Decentralized Identifier - `action` string — Action executed - `actionData` string — Action Data - `pii` PIIIVMS - `originator` PiiOriginator — The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer. - `originatorPersons` PiiPerson[], required — the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer. - `naturalPerson` PiiNaturalPerson - `name` PiiNaturalPersonName[], required — the distinct words used as identification for an individual - `nameIdentifier` PiiNaturalPersonNameID[], required — full name separated into primary and secondary identifier. - … - `localNameIdentifier` PiiLocalNaturalPersonNameID[] — full name separated into primary and secondary identifier using local characters. - … - `phoneticNameIdentifier` PiiLocalNaturalPersonNameID[] — Alternate representation of a name that corresponds to the manner the name is pronounced. - … - `geographicAddress` PiiAddress[] — the particulars of a location at which a person may be communicated with. - `addressType` string — A character string - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — A character string - `nationalIdentification` PiiNationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` string, required — A character string - `countryOfIssue` string — A character string - `registrationAuthority` string — A character string - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` PiiDateAndPlaceOfBirth - `dateOfBirth` string, required — A character string - `placeOfBirth` string, required — A character string - `countryOfResidence` string — A character string - `legalPerson` PiiLegalPerson - `name` PiiLegalPersonName, required - `nameIdentifier` PiiLegalPersonNameID[], required — The name and type of name by which the legal person is known. - … - `localNameIdentifier` PiiLocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `phoneticNameIdentifier` PiiLocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `geographicAddress` PiiAddress[] - `addressType` string — A character string - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — A character string - `customerNumber` string — A character string - `nationalIdentification` PiiNationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` string, required — A character string - `countryOfIssue` string — A character string - `registrationAuthority` string — A character string - `dateOfRegistration` string — A character string - `countryOfRegistration` string — A character string - `accountNumber` Text[] — Identifier of an account that is used to process the transfer. The value for this element is case-sensitive. - `beneficiary` PiiBeneficiary — The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer. - `beneficiaryPersons` PiiPerson[], required — the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer. - `naturalPerson` PiiNaturalPerson - `name` PiiNaturalPersonName[], required — the distinct words used as identification for an individual - `nameIdentifier` PiiNaturalPersonNameID[], required — full name separated into primary and secondary identifier. - … - `localNameIdentifier` PiiLocalNaturalPersonNameID[] — full name separated into primary and secondary identifier using local characters. - … - `phoneticNameIdentifier` PiiLocalNaturalPersonNameID[] — Alternate representation of a name that corresponds to the manner the name is pronounced. - … - `geographicAddress` PiiAddress[] — the particulars of a location at which a person may be communicated with. - `addressType` string — A character string - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — A character string - `nationalIdentification` PiiNationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` string, required — A character string - `countryOfIssue` string — A character string - `registrationAuthority` string — A character string - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` PiiDateAndPlaceOfBirth - `dateOfBirth` string, required — A character string - `placeOfBirth` string, required — A character string - `countryOfResidence` string — A character string - `legalPerson` PiiLegalPerson - `name` PiiLegalPersonName, required - `nameIdentifier` PiiLegalPersonNameID[], required — The name and type of name by which the legal person is known. - … - `localNameIdentifier` PiiLocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `phoneticNameIdentifier` PiiLocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `geographicAddress` PiiAddress[] - `addressType` string — A character string - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — A character string - `customerNumber` string — A character string - `nationalIdentification` PiiNationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` string, required — A character string - `countryOfIssue` string — A character string - `registrationAuthority` string — A character string - `dateOfRegistration` string — A character string - `countryOfRegistration` string — A character string - `accountNumber` Text[] — Identifier of an account that is used to process the transfer. The value for this element is case-sensitive. - `originatingVASP` PiiOriginatingVASP — The originating VASP is defined in Section 1.1 as the VASP which initiates the VA transfer, and transfers the VA upon receiving the request for a VA transfer on behalf of the originator. - `originatingVASP` PiiPerson - `naturalPerson` PiiNaturalPerson - `name` PiiNaturalPersonName[], required — the distinct words used as identification for an individual - `nameIdentifier` PiiNaturalPersonNameID[], required — full name separated into primary and secondary identifier. - … - `localNameIdentifier` PiiLocalNaturalPersonNameID[] — full name separated into primary and secondary identifier using local characters. - … - `phoneticNameIdentifier` PiiLocalNaturalPersonNameID[] — Alternate representation of a name that corresponds to the manner the name is pronounced. - … - `geographicAddress` PiiAddress[] — the particulars of a location at which a person may be communicated with. - `addressType` string — A character string - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — A character string - `nationalIdentification` PiiNationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` string, required — A character string - `countryOfIssue` string — A character string - `registrationAuthority` string — A character string - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` PiiDateAndPlaceOfBirth - `dateOfBirth` string, required — A character string - `placeOfBirth` string, required — A character string - `countryOfResidence` string — A character string - `legalPerson` PiiLegalPerson - `name` PiiLegalPersonName, required - `nameIdentifier` PiiLegalPersonNameID[], required — The name and type of name by which the legal person is known. - … - `localNameIdentifier` PiiLocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `phoneticNameIdentifier` PiiLocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `geographicAddress` PiiAddress[] - `addressType` string — A character string - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — A character string - `customerNumber` string — A character string - `nationalIdentification` PiiNationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` string, required — A character string - `countryOfIssue` string — A character string - `registrationAuthority` string — A character string - `dateOfRegistration` string — A character string - `countryOfRegistration` string — A character string - `beneficiaryVASP` PiiBeneficiaryVASP — The beneficiary is defined in Section 1.1 as the VASP which receives the transfer of a virtual asset from the originating VASP directly or through an intermediary VASP and makes the funds available to the beneficiary. - `beneficiaryVASP` PiiPerson - `naturalPerson` PiiNaturalPerson - `name` PiiNaturalPersonName[], required — the distinct words used as identification for an individual - `nameIdentifier` PiiNaturalPersonNameID[], required — full name separated into primary and secondary identifier. - … - `localNameIdentifier` PiiLocalNaturalPersonNameID[] — full name separated into primary and secondary identifier using local characters. - … - `phoneticNameIdentifier` PiiLocalNaturalPersonNameID[] — Alternate representation of a name that corresponds to the manner the name is pronounced. - … - `geographicAddress` PiiAddress[] — the particulars of a location at which a person may be communicated with. - `addressType` string — A character string - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — A character string - `nationalIdentification` PiiNationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` string, required — A character string - `countryOfIssue` string — A character string - `registrationAuthority` string — A character string - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` PiiDateAndPlaceOfBirth - `dateOfBirth` string, required — A character string - `placeOfBirth` string, required — A character string - `countryOfResidence` string — A character string - `legalPerson` PiiLegalPerson - `name` PiiLegalPersonName, required - `nameIdentifier` PiiLegalPersonNameID[], required — The name and type of name by which the legal person is known. - … - `localNameIdentifier` PiiLocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `phoneticNameIdentifier` PiiLocalLegalPersonNameID[] — The name and type of name by which the legal person is known using local characters. - … - `geographicAddress` PiiAddress[] - `addressType` string — A character string - `department` string — A character string - `subDepartment` string — A character string - `streetName` string — A character string - `buildingNumber` string — A character string - `buildingName` string — A character string - `floor` string — A character string - `postBox` string — A character string - `room` string — A character string - `postCode` string — A character string - `townName` string — A character string - `townLocationName` string — A character string - `districtName` string — A character string - `countrySubDivision` string — A character string - `addressLine` Text[] — Information that locates and identifies a specific address, as defined by postal services, presented in free format text. - `country` string — A character string - `customerNumber` string — A character string - `nationalIdentification` PiiNationalIdentification - `nationalIdentifier` string, required — A character string - `nationalIdentifierType` string, required — A character string - `countryOfIssue` string — A character string - `registrationAuthority` string — A character string - `dateOfRegistration` string — A character string - `countryOfRegistration` string — A character string - `transferPath` PiiTransferPath — The transfer path refers to the intermediary VASP(s) participating in a serial chain that receive(s) and retransmit(s) a VA transfer on behalf of the originating VASP and the beneficiary VASP, or another intermediary VASP, together with their corresponding sequence number. - `transferPath` PiiIntermediaryVASP[] — the intermediary VASP(s) participating in a serial chain that receive and retransmit a VA transfer on behalf of the originating VASP and the beneficiary VASP, or another intermediary VASP, together with their corresponding sequence number. - `intermediaryVASP` PiiPerson, required - `naturalPerson` PiiNaturalPerson - `name` PiiNaturalPersonName[], required — the distinct words used as identification for an individual - … - `geographicAddress` PiiAddress[] — the particulars of a location at which a person may be communicated with. - … - `nationalIdentification` PiiNationalIdentification - … - `customerIdentification` string — A character string - `dateAndPlaceOfBirth` PiiDateAndPlaceOfBirth - … - `countryOfResidence` string — A character string - `legalPerson` PiiLegalPerson - `name` PiiLegalPersonName, required - … - `geographicAddress` PiiAddress[] - … - `customerNumber` string — A character string - `nationalIdentification` PiiNationalIdentification - … - `dateOfRegistration` string — A character string - `countryOfRegistration` string — A character string - `sequence` string, required — A character string - `payloadMetadata` PiiPayloadMetadata — Data describing the contents of the payload. - `transliterationMethod` Text[] — the method used to map from a national system of writing to Latin script. --- [API](https://skmtc.net/notabene/apis/notabene-api.md) · [All operations](https://skmtc.net/notabene/apis/notabene-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/notabene/notabene-api/versions/70056745a433/schema)