We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Web3 Services
API Overview
Configurations
Configurations
Developer-Controlled Wallets
Smart Contract Platform
User-Controlled Wallets
Compliance Engine
USDC Access
Receive PII for transaction
POSThttps://api.circle.com/v1/w3s/compliance/travelRule/receivePii
Checks whether there is a Travel Rule message for a given transaction.
Body parameters
customerJurisdiction
string
Required
transactionId
string
Unique identifier of the transaction.
travelRuleId
string
Unique identifier of the Travel Rule message.
Response
RequestChoose a language
ResponseChoose an example
1{
2 "amount": "",
3 "beneficiaryProof": {
4 "proof": "",
5 "type": ""
6 },
7 "beneficiaryVasp": {
8 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
9 "name": ""
10 },
11 "createDate": "2023-01-01T12:04:05Z",
12 "destinationAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
13 "id": "36790743-b78d-4061-9558-1af9a9c837bd",
14 "ivms101": {
15 "beneficiary": {
16 "accountNumber": [
17 ""
18 ],
19 "beneficiaryPerson": [
20 {
21 "legalPerson": {
22 "countryOfRegistration": "",
23 "customerIdentification": "",
24 "geographicAddress": [
25 {
26 "addressLine": [
27 ""
28 ],
29 "addressType": "",
30 "buildingName": "",
31 "buildingNumber": "",
32 "country": "",
33 "countrySubDivision": "",
34 "department": "",
35 "districtName": "",
36 "floor": "",
37 "postBox": "",
38 "postcode": "",
39 "room": "",
40 "streetName": "",
41 "subDepartment": "",
42 "townLocationName": "",
43 "townName": ""
44 }
45 ],
46 "name": {
47 "localNameIdentifier": [
48 {
49 "legalPersonName": "",
50 "legalPersonNameIdentifierType": ""
51 }
52 ],
53 "nameIdentifier": [
54 {
55 "legalPersonName": "",
56 "legalPersonNameIdentifierType": ""
57 }
58 ],
59 "phoneticNameIdentifier": [
60 {
61 "legalPersonName": "",
62 "legalPersonNameIdentifierType": ""
63 }
64 ]
65 },
66 "nationalIdentification": {
67 "countryOfIssue": "",
68 "nationalIdentifier": "",
69 "nationalIdentifierType": "",
70 "registrationAuthority": ""
71 }
72 },
73 "naturalPerson": {
74 "countryOfResidence": "",
75 "customerIdentification": "",
76 "dateAndPlaceOfBirth": {
77 "dateOfBirth": "",
78 "placeOfBirth": ""
79 },
80 "geographicAddress": [
81 {
82 "addressLine": [
83 ""
84 ],
85 "addressType": "",
86 "buildingName": "",
87 "buildingNumber": "",
88 "country": "",
89 "countrySubDivision": "",
90 "department": "",
91 "districtName": "",
92 "floor": "",
93 "postBox": "",
94 "postcode": "",
95 "room": "",
96 "streetName": "",
97 "subDepartment": "",
98 "townLocationName": "",
99 "townName": ""
100 }
101 ],
102 "name": {
103 "localNameIdentifier": [
104 {
105 "nameIdentifierType": "",
106 "primaryIdentifier": "",
107 "secondaryIdentifier": ""
108 }
109 ],
110 "nameIdentifier": [
111 {
112 "nameIdentifierType": "",
113 "primaryIdentifier": "",
114 "secondaryIdentifier": ""
115 }
116 ],
117 "phoneticNameIdentifier": [
118 {
119 "nameIdentifierType": "",
120 "primaryIdentifier": "",
121 "secondaryIdentifier": ""
122 }
123 ]
124 },
125 "nationalIdentification": {
126 "countryOfIssue": "",
127 "nationalIdentifier": "",
128 "nationalIdentifierType": "",
129 "registrationAuthority": ""
130 }
131 }
132 }
133 ]
134 },
135 "beneficiaryVASP": {
136 "beneficiaryVASP": {
137 "legalPerson": {
138 "countryOfRegistration": "",
139 "customerIdentification": "",
140 "geographicAddress": [
141 {
142 "addressLine": [
143 ""
144 ],
145 "addressType": "",
146 "buildingName": "",
147 "buildingNumber": "",
148 "country": "",
149 "countrySubDivision": "",
150 "department": "",
151 "districtName": "",
152 "floor": "",
153 "postBox": "",
154 "postcode": "",
155 "room": "",
156 "streetName": "",
157 "subDepartment": "",
158 "townLocationName": "",
159 "townName": ""
160 }
161 ],
162 "name": {
163 "localNameIdentifier": [
164 {
165 "legalPersonName": "",
166 "legalPersonNameIdentifierType": ""
167 }
168 ],
169 "nameIdentifier": [
170 {
171 "legalPersonName": "",
172 "legalPersonNameIdentifierType": ""
173 }
174 ],
175 "phoneticNameIdentifier": [
176 {
177 "legalPersonName": "",
178 "legalPersonNameIdentifierType": ""
179 }
180 ]
181 },
182 "nationalIdentification": {
183 "countryOfIssue": "",
184 "nationalIdentifier": "",
185 "nationalIdentifierType": "",
186 "registrationAuthority": ""
187 }
188 },
189 "naturalPerson": {
190 "countryOfResidence": "",
191 "customerIdentification": "",
192 "dateAndPlaceOfBirth": {
193 "dateOfBirth": "",
194 "placeOfBirth": ""
195 },
196 "geographicAddress": [
197 {
198 "addressLine": [
199 ""
200 ],
201 "addressType": "",
202 "buildingName": "",
203 "buildingNumber": "",
204 "country": "",
205 "countrySubDivision": "",
206 "department": "",
207 "districtName": "",
208 "floor": "",
209 "postBox": "",
210 "postcode": "",
211 "room": "",
212 "streetName": "",
213 "subDepartment": "",
214 "townLocationName": "",
215 "townName": ""
216 }
217 ],
218 "name": {
219 "localNameIdentifier": [
220 {
221 "nameIdentifierType": "",
222 "primaryIdentifier": "",
223 "secondaryIdentifier": ""
224 }
225 ],
226 "nameIdentifier": [
227 {
228 "nameIdentifierType": "",
229 "primaryIdentifier": "",
230 "secondaryIdentifier": ""
231 }
232 ],
233 "phoneticNameIdentifier": [
234 {
235 "nameIdentifierType": "",
236 "primaryIdentifier": "",
237 "secondaryIdentifier": ""
238 }
239 ]
240 },
241 "nationalIdentification": {
242 "countryOfIssue": "",
243 "nationalIdentifier": "",
244 "nationalIdentifierType": "",
245 "registrationAuthority": ""
246 }
247 }
248 }
249 },
250 "originatingVASP": {
251 "originatingVASP": {
252 "legalPerson": {
253 "countryOfRegistration": "",
254 "customerIdentification": "",
255 "geographicAddress": [
256 {
257 "addressLine": [
258 ""
259 ],
260 "addressType": "",
261 "buildingName": "",
262 "buildingNumber": "",
263 "country": "",
264 "countrySubDivision": "",
265 "department": "",
266 "districtName": "",
267 "floor": "",
268 "postBox": "",
269 "postcode": "",
270 "room": "",
271 "streetName": "",
272 "subDepartment": "",
273 "townLocationName": "",
274 "townName": ""
275 }
276 ],
277 "name": {
278 "localNameIdentifier": [
279 {
280 "legalPersonName": "",
281 "legalPersonNameIdentifierType": ""
282 }
283 ],
284 "nameIdentifier": [
285 {
286 "legalPersonName": "",
287 "legalPersonNameIdentifierType": ""
288 }
289 ],
290 "phoneticNameIdentifier": [
291 {
292 "legalPersonName": "",
293 "legalPersonNameIdentifierType": ""
294 }
295 ]
296 },
297 "nationalIdentification": {
298 "countryOfIssue": "",
299 "nationalIdentifier": "",
300 "nationalIdentifierType": "",
301 "registrationAuthority": ""
302 }
303 },
304 "naturalPerson": {
305 "countryOfResidence": "",
306 "customerIdentification": "",
307 "dateAndPlaceOfBirth": {
308 "dateOfBirth": "",
309 "placeOfBirth": ""
310 },
311 "geographicAddress": [
312 {
313 "addressLine": [
314 ""
315 ],
316 "addressType": "",
317 "buildingName": "",
318 "buildingNumber": "",
319 "country": "",
320 "countrySubDivision": "",
321 "department": "",
322 "districtName": "",
323 "floor": "",
324 "postBox": "",
325 "postcode": "",
326 "room": "",
327 "streetName": "",
328 "subDepartment": "",
329 "townLocationName": "",
330 "townName": ""
331 }
332 ],
333 "name": {
334 "localNameIdentifier": [
335 {
336 "nameIdentifierType": "",
337 "primaryIdentifier": "",
338 "secondaryIdentifier": ""
339 }
340 ],
341 "nameIdentifier": [
342 {
343 "nameIdentifierType": "",
344 "primaryIdentifier": "",
345 "secondaryIdentifier": ""
346 }
347 ],
348 "phoneticNameIdentifier": [
349 {
350 "nameIdentifierType": "",
351 "primaryIdentifier": "",
352 "secondaryIdentifier": ""
353 }
354 ]
355 },
356 "nationalIdentification": {
357 "countryOfIssue": "",
358 "nationalIdentifier": "",
359 "nationalIdentifierType": "",
360 "registrationAuthority": ""
361 }
362 }
363 }
364 },
365 "originator": {
366 "accountNumber": [
367 ""
368 ],
369 "originatorPersons": [
370 {
371 "legalPerson": {
372 "countryOfRegistration": "",
373 "customerIdentification": "",
374 "geographicAddress": [
375 {
376 "addressLine": [
377 ""
378 ],
379 "addressType": "",
380 "buildingName": "",
381 "buildingNumber": "",
382 "country": "",
383 "countrySubDivision": "",
384 "department": "",
385 "districtName": "",
386 "floor": "",
387 "postBox": "",
388 "postcode": "",
389 "room": "",
390 "streetName": "",
391 "subDepartment": "",
392 "townLocationName": "",
393 "townName": ""
394 }
395 ],
396 "name": {
397 "localNameIdentifier": [
398 {
399 "legalPersonName": "",
400 "legalPersonNameIdentifierType": ""
401 }
402 ],
403 "nameIdentifier": [
404 {
405 "legalPersonName": "",
406 "legalPersonNameIdentifierType": ""
407 }
408 ],
409 "phoneticNameIdentifier": [
410 {
411 "legalPersonName": "",
412 "legalPersonNameIdentifierType": ""
413 }
414 ]
415 },
416 "nationalIdentification": {
417 "countryOfIssue": "",
418 "nationalIdentifier": "",
419 "nationalIdentifierType": "",
420 "registrationAuthority": ""
421 }
422 },
423 "naturalPerson": {
424 "countryOfResidence": "",
425 "customerIdentification": "",
426 "dateAndPlaceOfBirth": {
427 "dateOfBirth": "",
428 "placeOfBirth": ""
429 },
430 "geographicAddress": [
431 {
432 "addressLine": [
433 ""
434 ],
435 "addressType": "",
436 "buildingName": "",
437 "buildingNumber": "",
438 "country": "",
439 "countrySubDivision": "",
440 "department": "",
441 "districtName": "",
442 "floor": "",
443 "postBox": "",
444 "postcode": "",
445 "room": "",
446 "streetName": "",
447 "subDepartment": "",
448 "townLocationName": "",
449 "townName": ""
450 }
451 ],
452 "name": {
453 "localNameIdentifier": [
454 {
455 "nameIdentifierType": "",
456 "primaryIdentifier": "",
457 "secondaryIdentifier": ""
458 }
459 ],
460 "nameIdentifier": [
461 {
462 "nameIdentifierType": "",
463 "primaryIdentifier": "",
464 "secondaryIdentifier": ""
465 }
466 ],
467 "phoneticNameIdentifier": [
468 {
469 "nameIdentifierType": "",
470 "primaryIdentifier": "",
471 "secondaryIdentifier": ""
472 }
473 ]
474 },
475 "nationalIdentification": {
476 "countryOfIssue": "",
477 "nationalIdentifier": "",
478 "nationalIdentifierType": "",
479 "registrationAuthority": ""
480 }
481 }
482 }
483 ]
484 },
485 "payloadMetadata": {
486 "transliterationMethod": ""
487 },
488 "transferPath": {
489 "transferPath": [
490 {
491 "intermediaryVASP": {
492 "legalPerson": {
493 "countryOfRegistration": "",
494 "customerIdentification": "",
495 "geographicAddress": [
496 {
497 "addressLine": [
498 ""
499 ],
500 "addressType": "",
501 "buildingName": "",
502 "buildingNumber": "",
503 "country": "",
504 "countrySubDivision": "",
505 "department": "",
506 "districtName": "",
507 "floor": "",
508 "postBox": "",
509 "postcode": "",
510 "room": "",
511 "streetName": "",
512 "subDepartment": "",
513 "townLocationName": "",
514 "townName": ""
515 }
516 ],
517 "name": {
518 "localNameIdentifier": [
519 {
520 "legalPersonName": "",
521 "legalPersonNameIdentifierType": ""
522 }
523 ],
524 "nameIdentifier": [
525 {
526 "legalPersonName": "",
527 "legalPersonNameIdentifierType": ""
528 }
529 ],
530 "phoneticNameIdentifier": [
531 {
532 "legalPersonName": "",
533 "legalPersonNameIdentifierType": ""
534 }
535 ]
536 },
537 "nationalIdentification": {
538 "countryOfIssue": "",
539 "nationalIdentifier": "",
540 "nationalIdentifierType": "",
541 "registrationAuthority": ""
542 }
543 },
544 "naturalPerson": {
545 "countryOfResidence": "",
546 "customerIdentification": "",
547 "dateAndPlaceOfBirth": {
548 "dateOfBirth": "",
549 "placeOfBirth": ""
550 },
551 "geographicAddress": [
552 {
553 "addressLine": [
554 ""
555 ],
556 "addressType": "",
557 "buildingName": "",
558 "buildingNumber": "",
559 "country": "",
560 "countrySubDivision": "",
561 "department": "",
562 "districtName": "",
563 "floor": "",
564 "postBox": "",
565 "postcode": "",
566 "room": "",
567 "streetName": "",
568 "subDepartment": "",
569 "townLocationName": "",
570 "townName": ""
571 }
572 ],
573 "name": {
574 "localNameIdentifier": [
575 {
576 "nameIdentifierType": "",
577 "primaryIdentifier": "",
578 "secondaryIdentifier": ""
579 }
580 ],
581 "nameIdentifier": [
582 {
583 "nameIdentifierType": "",
584 "primaryIdentifier": "",
585 "secondaryIdentifier": ""
586 }
587 ],
588 "phoneticNameIdentifier": [
589 {
590 "nameIdentifierType": "",
591 "primaryIdentifier": "",
592 "secondaryIdentifier": ""
593 }
594 ]
595 },
596 "nationalIdentification": {
597 "countryOfIssue": "",
598 "nationalIdentifier": "",
599 "nationalIdentifierType": "",
600 "registrationAuthority": ""
601 }
602 }
603 },
604 "sequence": 0
605 }
606 ]
607 }
608 },
609 "operation": "TRAVEL_RULE",
610 "originatorProof": {
611 "proof": "",
612 "type": ""
613 },
614 "originatorVasp": {
615 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
616 "name": ""
617 },
618 "protocol": "",
619 "sourceAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
620 "status": "SENT",
621 "token": "ETH",
622 "transactionType": "INBOUND",
623 "txHash": "",
624 "updateDate": "2023-01-01T12:04:05Z"
625}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
