/api/verify/outnetwork/register

Version: 3.0.0

Method

POST

Url

https://platform.globaltravelrule.com/api/verify/outnetwork/register

eu post travel rule

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Required)

Schema

[+]beneficiaryAddress

RequiredObject

[+]blockchainTransaction

RequiredObject

[+]complianceInfo

RequiredObject

[+]originatorAddress

RequiredObject

requestId

OptionalString

Min Length0

Max Length64

Pattern

[\w\d_=-]+

sourceVaspCode

OptionalString

targetVaspName

OptionalString

Min Length1

[+]transmittedContent

OptionalObject

[+]verifyInstructions

RequiredObject

Example

{
  "originatorAddress": {
    "address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
    "tag": "some of network like XRP required to input address tag (memo)"
  },
  "requestId": "string",
  "transmittedContent": {
    "manifest": [
      {
        "isNull": true,
        "fieldPath": "string",
        "count": 0,
        "index": 0,
        "fieldType": "string",
        "fieldId": "string",
        "contentHash": "string"
      }
    ],
    "travelRuleMetadata": {
      "validationSalt": "string",
      "nullHashExample": "string",
      "hashAlgorithm": "string"
    }
  },
  "sourceVaspCode": "string",
  "targetVaspName": "string",
  "blockchainTransaction": {
    "ticker": "string",
    "txId": "string",
    "network": "string"
  },
  "beneficiaryAddress": {
    "address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
    "tag": "some of network like XRP required to input address tag (memo)"
  },
  "complianceInfo": {
    "amount": 8e-18,
    "fiatName": "USD",
    "fiatPrice": 84.12
  },
  "verifyInstructions": {
    "piiSpecVersion": "string",
    "verifyDirection": 0,
    "expectVerifyFields": [
      "string"
    ]
  }
}

Responses

Status 200

OK

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

OptionalInteger (int32)

Example

{
  "verifyStatus": 0,
  "data": {
    "addressScreeningResult": {
      "vaspEntityId": "axchange-uk",
      "vaspEntityName": "Axchange UK",
      "riskTags": [
        "Exchange & Trading Platforms",
        "Centralized Exchange",
        "Unknown Wallet"
      ],
      "vaspCode": "axchangeukadjk",
      "riskScore": 4,
      "message": "screening result present",
      "screeningStatus": "COMPLETED",
      "categoryId": 0
    }
  },
  "verifyMessage": "string"
}