BeaconUserCreateRequest (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.BeaconUserCreateRequest

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class BeaconUserCreateRequest
extends Object
```
Request input for creating a Beacon User. The primary use for this endpoint is to add a new end user to Beacon for fraud and duplicate scanning. This endpoint can also be used to import historical fraud cases into the Beacon Network without being charged for creating a Beacon User. To import historical fraud cases, embed the fraud report in the optional `report` section of the request payload.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_CLIENT_USER_ID`
`static String`	`SERIALIZED_NAME_PROGRAM_ID`
`static String`	`SERIALIZED_NAME_REPORT`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_USER`

Constructor Summary

Constructors
Constructor and Description

BeaconUserCreateRequest()

Constructors
Constructor and Description
`BeaconUserCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BeaconUserCreateRequest`	`clientId(String clientId)`
`BeaconUserCreateRequest`	`clientUserId(String clientUserId)`
`boolean`	`equals(Object o)`
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getClientUserId()` A unique ID that identifies the end user in your system.
`String`	`getProgramId()` ID of the associated Beacon Program.
`BeaconUserCreateEmbeddedReport`	`getReport()` Get report
`String`	`getSecret()` Your Plaid API `secret`.
`BeaconUserRequestData`	`getUser()` Get user
`int`	`hashCode()`
`BeaconUserCreateRequest`	`programId(String programId)`
`BeaconUserCreateRequest`	`report(BeaconUserCreateEmbeddedReport report)`
`BeaconUserCreateRequest`	`secret(String secret)`
`void`	`setClientId(String clientId)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setProgramId(String programId)`
`void`	`setReport(BeaconUserCreateEmbeddedReport report)`
`void`	`setSecret(String secret)`
`void`	`setUser(BeaconUserRequestData user)`
`String`	`toString()`
`BeaconUserCreateRequest`	`user(BeaconUserRequestData user)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_PROGRAM_ID
```
public static final String SERIALIZED_NAME_PROGRAM_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT_USER_ID
```
public static final String SERIALIZED_NAME_CLIENT_USER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER
```
public static final String SERIALIZED_NAME_USER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REPORT
```
public static final String SERIALIZED_NAME_REPORT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT_ID
```
public static final String SERIALIZED_NAME_CLIENT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SECRET
```
public static final String SERIALIZED_NAME_SECRET
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BeaconUserCreateRequest
```
public BeaconUserCreateRequest()
```
- Method Detail
  - programId
```
public BeaconUserCreateRequest programId(String programId)
```
  - getProgramId
```
public String getProgramId()
```
    ID of the associated Beacon Program.
    
    Returns:
    
    programId
  - setProgramId
```
public void setProgramId(String programId)
```
  - clientUserId
```
public BeaconUserCreateRequest clientUserId(String clientUserId)
```
  - getClientUserId
```
public String getClientUserId()
```
    A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the `/link/token/create` `client_user_id` to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
    
    Returns:
    
    clientUserId
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - user
```
public BeaconUserCreateRequest user(BeaconUserRequestData user)
```
  - getUser
```
public BeaconUserRequestData getUser()
```
    Get user
    
    Returns:
    
    user
  - setUser
```
public void setUser(BeaconUserRequestData user)
```
  - report
```
public BeaconUserCreateRequest report(BeaconUserCreateEmbeddedReport report)
```
  - getReport
```
@Nullable
public BeaconUserCreateEmbeddedReport getReport()
```
    Get report
    
    Returns:
    
    report
  - setReport
```
public void setReport(BeaconUserCreateEmbeddedReport report)
```
  - clientId
```
public BeaconUserCreateRequest clientId(String clientId)
```
  - getClientId
```
@Nullable
public String getClientId()
```
    Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
    
    Returns:
    
    clientId
  - setClientId
```
public void setClientId(String clientId)
```
  - secret
```
public BeaconUserCreateRequest secret(String secret)
```
  - getSecret
```
@Nullable
public String getSecret()
```
    Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
    
    Returns:
    
    secret
  - setSecret
```
public void setSecret(String secret)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BeaconUserCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_PROGRAM_ID

SERIALIZED_NAME_CLIENT_USER_ID

SERIALIZED_NAME_USER

SERIALIZED_NAME_REPORT

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

Constructor Detail

BeaconUserCreateRequest

Method Detail

programId

getProgramId

setProgramId

clientUserId

getClientUserId

setClientUserId

user

getUser

setUser

report

getReport

setReport

clientId

getClientId

setClientId

secret

getSecret

setSecret

equals

hashCode

toString