Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Ofac

OFAC2 Cure Gate for Enrollment

Update Consumer Information and perform OFAC checks.

post/programs/{programCode}/users/{userIdentifier}/ofacGates/ofac2

Path parameters

programCodestring required

The Program code for the enrollment flow.

userIdentifierstring required

The Unique identifier of the user for the enrollment and OFAC validation.

Headers

X-GD-RequestIdstring required

The Unique request identifier for tracking and logging.

X-GD-Sourcestring

The Source system or channel identifier.

X-Gd-Bos-IgnoreMFAstring

Specifies whether multi-factor authentication (MFA) should be bypassed for this request. Accepts "true" to skip MFA enforcement; otherwise MFA policies apply.

X-GD-EnrollmentRequestIdentifierstring

The Unique identifier for the enrollment request.

Request body

accountIdentifierstring nullable

The unique identifier of the Account for OFAC verification. Used internally for correlation and tracking; not serialized in the request payload.

enrollmentRequestIdentifierstring nullable

The enrollmentRequestIdenifier related with the initial Request for the Enrollment. .

Response

OK

Example response

{
  "account": {
    "accountIdentifier": "50d51e2f-9ea8-4ffb-bc1f-7a2ac60bee8d",
    "accountReferenceNumber": "YEP6449136",
    "status": "normal",
    "accountStatusChangedDateTime": "2022-01-27T17:30:54.037Z",
    "statusReasons": [
      "healthy"
    ],
    "directDepositInformation": {
      "accountNumber": "101042265200589",
      "routingNumber": "096017418"
    },
    "purses": [
      {
        "purseIdentifier": "cf26903d-f1b3-46df-9d22-b7492875fdbc",
        "purseType": "primary",
        "availableBalance": 0,
        "ledgerBalance": 0,
        "availableBalanceAsOfDateTime": "2022-01-27T18:30:49Z",
        "ledgerBalanceAsOfDateTime": "2022-01-27T18:30:49Z",
        "isHidden": false,
        "status": "active"
      }
    ],
    "accountHolders": [
      {
        "paymentInstruments": [
          {
            "encryptedPrivatePaymentInstrumentData": {
              "version": "EC_v1",
              "ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE6HF7whJ3zNH46NC6YuYrOMeAXnllpotZH9cPZ1iHKUG4GRlT5Cqj3vYOE7PK8FOKMjjD9ESl56ckIylWEqMw/w==",
              "publicKeyHash": "yMzWGqHkTvk++4p4XJNSLVWJ7qKEzV7+w/M4BioKiyI=",
              "data": "OmK78WmAZojsgR6HeL6kkN4gv4qwb4UNy8CgkZkp5zSM9h0Fi3ufDo62UIo/F5VwdaTkQYYAxF6QAUy7qLR/KFc8XJ5JSVSrELMpfNfKMIwI1M6mehI5MREmd9sugl42"
            },
            "paymentIdentifier": "07f4074b-ebe2-4f11-aaac-d19eb4150f00",
            "paymentInstrumentIdentifier": "80225c0d-ff5f-4158-b1e9-29538f79d913",
            "paymentInstrumentType": "virtual",
            "status": "activated",
            "isPinSet": false,
            "last4Pan": "9852",
            "activatedDateTime": "2022-01-27T17:30:49Z",
            "issuedDateTime": "2022-01-27T17:30:49Z",
            "isPrivateDataViewable": false
          },
          {
            "paymentIdentifier": "07f4074b-ebe2-4f11-aaac-d19eb4150f00",
            "paymentInstrumentIdentifier": "372dc129-33c0-431e-a75f-a07f8547e9ee",
            "paymentInstrumentType": "contactlessEmv",
            "status": "notActivated",
            "isPinSet": false,
            "last4Pan": "9852",
            "issuedDateTime": "2022-01-27T17:30:51Z",
            "isPrivateDataViewable": false
          }
        ],
        "user": {
          "firstName": "Bob JR",
          "lastName": "BOBJINJALA",
          "dobStatus": "matched",
          "last4Identity": "4183",
          "identityType": "ssn",
          "userIdentifier": "114fa377-d42d-4575-a4e9-78258e76f173",
          "status": "active",
          "isPrimaryAccountHolder": true,
          "kycStateData": {
            "ofacStatus": "passed",
            "kycStatus": "passed",
            "kycPendingGate": "healthy"
          }
        }
      }
    ],
    "accountCycleDay": 27
  },
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "Success",
      "url": "http://tbd"
    }
  ]
}