aboutsummaryrefslogtreecommitdiff
path: root/packages/aml-backoffice-ui/src/types.ts
blob: 1197b6b35cf578b611c61291d17b600e80b3ba8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
export interface AmlDecisionDetails {
  // Array of AML decisions made for this account. Possibly
  // contains only the most recent decision if "history" was
  // not set to 'true'.
  aml_history: AmlDecisionDetail[];

  // Array of KYC attributes obtained for this account.
  kyc_attributes: KycDetail[];
}

type AmlOfficerPublicKeyP = string;

export interface AmlDecisionDetail {
  // What was the justification given?
  justification: string;

  // What is the new AML state.
  new_state: Integer;

  // When was this decision made?
  decision_time: Timestamp;

  // What is the new AML decision threshold (in monthly transaction volume)?
  new_threshold: Amount;

  // Who made the decision?
  decider_pub: AmlOfficerPublicKeyP;
}
export interface KycDetail {
  // Name of the configuration section that specifies the provider
  // which was used to collect the KYC details
  provider_section: string;

  // The collected KYC data.  NULL if the attribute data could not
  // be decrypted (internal error of the exchange, likely the
  // attribute key was changed).
  attributes?: Object;

  // Time when the KYC data was collected
  collection_time: Timestamp;

  // Time when the validity of the KYC data will expire
  expiration_time: Timestamp;
}

interface Timestamp {
  // Seconds since epoch, or the special
  // value "never" to represent an event that will
  // never happen.
  t_s: number | "never";
}

type PaytoHash = string;
type Integer = number;
type Amount = string;

export interface AmlRecords {
  // Array of AML records matching the query.
  records: AmlRecord[];
}

interface AmlRecord {
  // Which payto-address is this record about.
  // Identifies a GNU Taler wallet or an affected bank account.
  h_payto: PaytoHash;

  // What is the current AML state.
  current_state: AmlState;

  // Monthly transaction threshold before a review will be triggered
  threshold: Amount;

  // RowID of the record.
  rowid: Integer;
}

export enum AmlState {
  normal = 0,
  pending = 1,
  frozen = 2,
}