Retrieve a Transaction Type

GET

https://api.withpersona.com/api/v1/transaction-types/:transaction-type-id

GET

/api/v1/transaction-types/:transaction-type-id

$ curl https://api.withpersona.com/api/v1/transaction-types/transaction-type-id \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": {
3     "type": "transaction-type",
4     "id": "txntp_5jr7hePm1772FBVG28vpBghC",
5     "attributes": {
6       "name": "Transaction Type A",
7       "created-at": "2023-05-09T21:49:02.514Z",
8       "updated-at": "2024-01-12T23:17:50.627Z",
9       "field-schemas": [
10         {
11           "type": "string",
12           "config": {
13             "archived-at": null,
14             "deactivated-at": null,
15             "max-char-length": 255,
16             "required": false,
17             "sanitize": []
18           },
19           "key": "name_first",
20           "label": "Name First"
21         },
22         {
23           "type": "string",
24           "config": {
25             "archived-at": null,
26             "deactivated-at": null,
27             "max-char-length": 255,
28             "required": false,
29             "sanitize": []
30           },
31           "key": "name_middle",
32           "label": "Name Middle"
33         },
34         {
35           "type": "string",
36           "config": {
37             "archived-at": null,
38             "deactivated-at": null,
39             "max-char-length": 255,
40             "required": false,
41             "sanitize": []
42           },
43           "key": "name_last",
44           "label": "Name Last"
45         },
46         {
47           "type": "string",
48           "config": {
49             "archived-at": null,
50             "deactivated-at": null,
51             "max-char-length": 255,
52             "required": false,
53             "sanitize": []
54           },
55           "key": "address_street_1",
56           "label": "Address Street 1"
57         },
58         {
59           "type": "string",
60           "config": {
61             "archived-at": null,
62             "deactivated-at": null,
63             "max-char-length": 255,
64             "required": false,
65             "sanitize": []
66           },
67           "key": "address_street_2",
68           "label": "Address Street 2"
69         },
70         {
71           "type": "string",
72           "config": {
73             "archived-at": null,
74             "deactivated-at": null,
75             "max-char-length": 255,
76             "required": false,
77             "sanitize": []
78           },
79           "key": "address_city",
80           "label": "Address City"
81         },
82         {
83           "type": "string",
84           "config": {
85             "archived-at": null,
86             "deactivated-at": null,
87             "max-char-length": 255,
88             "required": false,
89             "sanitize": []
90           },
91           "key": "address_subdivision",
92           "label": "Address Subdivision"
93         },
94         {
95           "type": "string",
96           "config": {
97             "archived-at": null,
98             "deactivated-at": null,
99             "max-char-length": 255,
100             "required": false,
101             "sanitize": []
102           },
103           "key": "address_postal_code",
104           "label": "Address Postal Code"
105         },
106         {
107           "type": "string",
108           "config": {
109             "archived-at": null,
110             "deactivated-at": null,
111             "max-char-length": 255,
112             "required": false,
113             "sanitize": []
114           },
115           "key": "address_country_code",
116           "label": "Address Country Code"
117         },
118         {
119           "type": "date",
120           "config": {
121             "archived-at": null,
122             "deactivated-at": null,
123             "max-date": null,
124             "min-date": null,
125             "required": false
126           },
127           "key": "birthdate",
128           "label": "Birthdate"
129         },
130         {
131           "type": "string",
132           "config": {
133             "archived-at": null,
134             "deactivated-at": null,
135             "max-char-length": 255,
136             "required": false,
137             "sanitize": []
138           },
139           "key": "email_address",
140           "label": "Email Address"
141         },
142         {
143           "type": "string",
144           "config": {
145             "archived-at": null,
146             "deactivated-at": null,
147             "max-char-length": 255,
148             "required": false,
149             "sanitize": []
150           },
151           "key": "phone_number",
152           "label": "Phone Number"
153         },
154         {
155           "type": "string",
156           "config": {
157             "archived-at": null,
158             "deactivated-at": null,
159             "max-char-length": 255,
160             "required": false,
161             "sanitize": []
162           },
163           "key": "identification_number",
164           "label": "Identification Number"
165         },
166         {
167           "type": "string",
168           "config": {
169             "archived-at": null,
170             "deactivated-at": null,
171             "max-char-length": 255,
172             "required": false,
173             "sanitize": []
174           },
175           "key": "identification_class",
176           "label": "Identification Class"
177         },
178         {
179           "type": "string",
180           "config": {
181             "archived-at": null,
182             "deactivated-at": null,
183             "max-char-length": 255,
184             "required": false,
185             "sanitize": []
186           },
187           "key": "selected_country_code",
188           "label": "Selected Country Code"
189         },
190         {
191           "type": "string",
192           "config": {
193             "archived-at": null,
194             "deactivated-at": null,
195             "max-char-length": 255,
196             "required": false,
197             "sanitize": []
198           },
199           "key": "selected_id_class",
200           "label": "Selected ID class"
201         },
202         {
203           "type": "relation-schema",
204           "config": {
205             "archived-at": null,
206             "deactivated-at": null,
207             "required": false,
208             "target": "document-government-id"
209           },
210           "key": "current_government_id",
211           "label": "Current Government ID"
212         }
213       ]
214     }
215   }
216 }

Retrieves the details of an existing Transaction Type.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

transaction-type-idstringRequired

ID of the Transaction Type to retrieve.

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

Response headers

RateLimit-Limitinteger

The maximum number of requests permitted in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.

RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.

RateLimit-Resetinteger

The number of seconds until the current rate limit window resets. Returned on every authenticated response.

Request-Idstring

The unique identifier of the API log entry that recorded this request. Starts with req_. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.

Persona-Environment-Idstring

The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.

Persona-Organization-Idstring

The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.

Response

This endpoint returns a Transaction Type object.

dataobject

includedlist of any

Excluded from the response by default. Will be an empty array when the include query parameter in the request was explicitly set to empty.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error